Class actuate.viewer.SelectedContent

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() Constructs a SelectedContent object with the given data.

Method Summary
Method Attributes	Method Name and Description
	getBookmark() Returns the book mark of the cell.
	getBrowserEventObject() Returns the browser event that was triggered from a table cell selection
	getColumnIndex() Returns the numerical index for the currently selected column, if the selected content is in a table.
	getRowIndex() Returns the row index for the currently selected column cell, if the selected content is in a table.
	getSelectedElement() Returns an instance of the currently selected element.

Class Detail

actuate.viewer.SelectedContent()

Constructs a SelectedContent object with the given data.

See:: actuate.viewer.EventConstants.ON_CONTENT_SELECTED

Method Detail

getBookmark()

Returns the book mark of the cell.

getBrowserEventObject()

Returns the browser event that was triggered from a table cell selection

{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.

getRowIndex()

Returns the row index for the currently selected column cell, if the selected content is in a table.

{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