Class actuate.viewer.SelectedContent

The SelectedContent class contains information about an element that has been selected by the user. It is passed to the CONTENT_SELECTED event handler.
Member of: actuate.viewer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.viewer.SelectedContent() A container for content selected in the viewer.

Method Summary
Method Attributes	Method Name and Description
	getColumnIndex() Returns the numerical index for the currently selected column, if the selected content is in a table.
	getSelectedElement() Returns an instance of the currently selected element.

Class Detail

actuate.viewer.SelectedContent()

A container for content selected in the viewer. SelectedContent provides an object to pass to a handler when the user-defined ON_CONTENT_SELECTED event occurs. This object contains an instance of the element selected in the viewer.

See:: actuate.viewer.EventConstants.ON_CONTENT_SELECTED

Method Detail

{int} getColumnIndex()

Returns the numerical index for the currently selected column, if the selected content is in a table. The first column has index 1. To retrieve the index of a column selected, use the following code:

	var index = selected.getColumnIndex( );

Returns:: {int} column index or null when the user selects a non-table element.

{Object} getSelectedElement()

Returns an instance of the currently selected element. The instance can be one of the following objects:

To determine the object type, use the Object.getType( ) function. The type strings for the above objects are "Chart", "Data", "Label", "Table", or "Text", respectively. To retrieve and store a label bookmark if a selected element is a label, use the following code:

	var selected = selected.getColumnIndex( );
	if (selected.getType( ) == "Label"){
		var bmark = Object.getBookmark( );
	}

Returns:: {Object} The selected element.

Classes

Class actuate.viewer.SelectedContent