com.iizix.prop.vs

Class VSRows

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.prop.ArrayProp<VSRow>

com.iizix.prop.vs.VSRows

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable

Direct Known Subclasses:

EditorVSRows

public class VSRows
extends ArrayProp<VSRow>

The rows property class that only allows VSRow children properties.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static VSRow[]	EMPTY_ROWS An empty array of rows.

Fields inherited from class com.iizix.prop.PropCnr

EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Constructor and Description
VSRows() Creates a VirtualSpace Rows property with the specified name with a null value.
VSRows(Atom propertyAtom) Creates an VirtualSpace Rows property with the specified name with a null value.

Method Summary

Modifier and Type	Method and Description
int	addEmptyRowsToCount(int rowCount) Adds empty rows so that the amount of rows is reached.
boolean	addListener(IVSTableRowSelectionListener listener) Adds a new table row selection listener.
void	clearSelection() Clears the selection without trigger component.
void	clearSelection(IGProp<?> trigger) Clears the selection with optional trigger component.
VSRows	clone() Clones the property.
VSRow	createRow() Creates a row with a unique name.
void	fireRowSelection() Fires the current row selection to listeners if the table is of single or multiple selection.
VSRow	getFirstSelectedRow() Gets the first selected row in the table if the selection type is single or multiple.
VSRow	getRow(int rowIndex) Gets the row at specified index.
int	getRowCount() Gets the count of rows.
VSRow[]	getRows() Gets the rows in this rows container.
int	getSelectedIndex() Gets the first selected row regardless of table selection by checking the VSRow selection state.
int[]	getSelectedIndicies() Gets the selected row indicies in the table if the selection type is single or multiple.
VSRow[]	getSelectedRows() Gets the rows that are selected.
VSTable	getTable() Gets the table of the row.
boolean	removeListener(IVSTableRowSelectionListener listener) Removes a table row selection listener.
boolean	setSelection(int index) Sets the single selection index without trigger component.
boolean	setSelection(int[] indicies) Sets the selection indices.
boolean	setSelection(int[] indicies, IGProp<?> trigger) Sets the selection indices.
boolean	setSelection(int index, IGProp<?> trigger) Sets the single selection index with optional trigger component.

Methods inherited from class com.iizix.prop.ArrayProp

getPossibleChildren, initializeElement, initializeProp, setItemClass, usesPropIndex

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeExtendsFramework, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IPropCnr

canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Field Detail

EMPTY_ROWS

public static final VSRow[] EMPTY_ROWS

An empty array of rows.

Constructor Detail

VSRows

public VSRows()

Creates a VirtualSpace Rows property with the specified name with a null value.

VSRows

public VSRows(Atom propertyAtom)

Creates an VirtualSpace Rows property with the specified name with a null value.

Parameters:

propertyAtom - The property atom.

Method Detail

createRow

public VSRow createRow()

Creates a row with a unique name.

Returns:

A new row with a unique name, not yet added to this row container.

getRows

public VSRow[] getRows()

Gets the rows in this rows container.

getTable

public VSTable getTable()

Gets the table of the row.

Returns:

The VirtualSpace Table instance, or null if row is not added to a table.

clone

public VSRows clone()

Clones the property.

Overrides:

clone in class ArrayProp<VSRow>

Returns:

A new cloned property.

getRowCount

public int getRowCount()

Gets the count of rows.

getRow

public VSRow getRow(int rowIndex)

Gets the row at specified index.

Parameters:

rowIndex - The row index.

Returns:

The row, or null if row is not found.

addEmptyRowsToCount

public int addEmptyRowsToCount(int rowCount)

Adds empty rows so that the amount of rows is reached.

Parameters:

rowCount - The row count requested.

Returns:

The amount of rows added.

getFirstSelectedRow

public VSRow getFirstSelectedRow()

Gets the first selected row in the table if the selection type is single or multiple.

Returns:

The selected row, null for none.

getSelectedIndex

public int getSelectedIndex()

Gets the first selected row regardless of table selection by checking the VSRow selection state.

Returns:

The selected row index, or -1 for none.

getSelectedRows

public VSRow[] getSelectedRows()

Gets the rows that are selected.

Returns:

An array with the selected rows, never null.

getSelectedIndicies

public int[] getSelectedIndicies()

Gets the selected row indicies in the table if the selection type is single or multiple.

Returns:

An array of the selected row indicies, or an empty array for no selection present.

clearSelection

public void clearSelection()

Clears the selection without trigger component.

clearSelection

public void clearSelection(IGProp<?> trigger)

Clears the selection with optional trigger component.

Parameters:

trigger - The trigger of the selection, null for none.

setSelection

public boolean setSelection(int index)

Sets the single selection index without trigger component.

Selection processing is done in the following way:
- select the new row index,
- unselect the other rows, starting with the first to last row.

This makes it possible to know if there are no selections remaining at an "unselection event".

Parameters:

index - The selected row index, or any negative value (e.g. -1) to clear the selection.

Returns:

true for success, false if index is out of bounds. In case of false return code, no selection or unselection is performed.

setSelection

public boolean setSelection(int index,
                            IGProp<?> trigger)

Sets the single selection index with optional trigger component.

Selection processing is done in the following way:
- select the new row index,
- unselect the other rows, starting with the first to last row.

This makes it possible to know if there are no selections remaining at an "unselection event".

Parameters:

index - The selected row index, or any negative value (e.g. -1) to clear the selection.

trigger - The trigger of the selection, null for none.

Returns:

true for success, false if index is out of bounds. In case of false return code, no selection or unselection is performed.

setSelection

public boolean setSelection(int[] indicies)

Sets the selection indices.

Selection processing is done in the following way:
- select the new row indicies,
- unselect the other rows, starting with the first to last row.

This makes it possible to know if there are no selections remaining at an "unselection event".

Parameters:

indicies - The selected row indicies.

Returns:

true for success, false if any index is out of bounds. In case of false return code, no selection or unselection is performed.

setSelection

public boolean setSelection(int[] indicies,
                            IGProp<?> trigger)

Sets the selection indices.

Selection processing is done in the following way:
- select the new row indicies,
- unselect the other rows, starting with the first to last row.

This makes it possible to know if there are no selections remaining at an "unselection event".

Parameters:

indicies - The selected row indicies.

trigger - The trigger of the selection, null for none.

Returns:

true for success, false if any index is out of bounds. In case of false return code, no selection or unselection is performed.

addListener

public boolean addListener(IVSTableRowSelectionListener listener)

Adds a new table row selection listener. Calling this method multiple times with the same listener will have no effect (but to return false).

Parameters:

listener - The listener to add.

Returns:

true if the listener was added, false otherwise.

Throws:

NullPointerException - If the listener is null.

removeListener

public boolean removeListener(IVSTableRowSelectionListener listener)

Removes a table row selection listener.

Parameters:

listener - The listener to remove.

Returns:

true if listener is successfully removed, false otherwise.

fireRowSelection

public void fireRowSelection()

Fires the current row selection to listeners if the table is of single or multiple selection. If no change of selection is present, nothing will be done.