Class Inx_Api_IndexSelection

Description

This class represents the current state of a selection.

This class represents the current state of a selection. It encapsulates a single selection interval.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $

Located in /Api/IndexSelection.php (line 11)


	
			
Method Summary
Inx_Api_IndexSelection __construct ([int $iBeginIndex = null], [int $iEndIndex = null])
int getFirstIndex ()
int getLastIndex ()
void setSelectionInterval ([int $iBeginIndex = null], [int $iEndIndex = null])
Methods
Constructor __construct (line 27)

Creates a selection.

Creates a selection. If $iBeginIndex and $iEndIndex are omitted, this will create an empty selection. If only $iEndIndex is omitted, the selection will contain only $iEndIndex. If both parameters are set, the selection will contain the set of indices between $iBeginIndex and $iEndIndex inclusive.

  • access: public
Inx_Api_IndexSelection __construct ([int $iBeginIndex = null], [int $iEndIndex = null])
  • int $iBeginIndex: one end of the interval, may be omitted.
  • int $iEndIndex: other ent of the interval (inclusive), may be omitted.
getFirstIndex (line 84)

Returns the first selected index or -1 if the selection is empty.

Returns the first selected index or -1 if the selection is empty.

  • return: the first selected index
  • access: public
int getFirstIndex ()
getLastIndex (line 95)

Returns the last selected index or -1 if the selection is empty.

Returns the last selected index or -1 if the selection is empty.

  • return: the last selected index
  • access: public
int getLastIndex ()
getSelectionCount (line 70)

Returns the number of selected elements.

Returns the number of selected elements.

  • return: the number of selected elements
  • access: public
int getSelectionCount ()
setSelectionInterval (line 47)

Change the selection to be the set of indices between $iBeginIndex and $iEndIndex inclusive.

Change the selection to be the set of indices between $iBeginIndex and $iEndIndex inclusive. $iEndIndex may be omitted, thus changing the selection to only contain $iBeginIndex.

  • access: public
void setSelectionInterval ([int $iBeginIndex = null], [int $iEndIndex = null])
  • int $iBeginIndex: one end of the interval.
  • int $iEndIndex: other end of the interval (inclusive), may be omitted.

Documentation generated on Thu, 17 Sep 2015 14:27:25 +0200 by phpDocumentor 1.3.2