Package com.iizix.prop.vs
Class VSRows
- All Implemented Interfaces:
EventListener,IGProp<GProp<?>[]>,IPropCnr,Cloneable
- Direct Known Subclasses:
EditorVSRows
The rows property class that only allows VSRow children properties.
- Author:
- Christopher Mindus
Field Summary
FieldsFields inherited from class com.iizix.prop.PropCnr
EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_IDFields 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_2Fields inherited from interface com.iizix.prop.IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_INCLUDE_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATEConstructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionintaddEmptyRowsToCount(int rowCount) Adds empty rows so that the amount of rows is reached.booleanaddListener(IVSTableRowSelectionListener listener) Adds a new table row selection listener.voidClears the selection without trigger component.voidclearSelection(IGProp<?> trigger) Clears the selection with optional trigger component.clone()Clones the property.Creates a row with a unique name.voidFires the current row selection to listeners if the table is of single or multiple selection.Gets the first selected row in the table if the selection type is single or multiple.getRow(int rowIndex) Gets the row at specified index.intGets the count of rows.VSRow[]getRows()Gets the rows in this rows container.intGets the first selected row regardless of table selection by checking the VSRow selection state.int[]Gets the selected row indicies in the table if the selection type is single or multiple.VSRow[]Gets the rows that are selected.getTable()Gets the table of the row.booleanremoveListener(IVSTableRowSelectionListener listener) Removes a table row selection listener.booleansetSelection(int index) Sets the single selection index without trigger component.booleansetSelection(int[] indicies) Sets the selection indices.booleansetSelection(int[] indicies, IGProp<?> trigger) Sets the selection indices.booleansetSelection(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, usesPropIndexMethods 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, 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, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeExtendsFramework, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, onVirtualContainerCreated, onVirtualizationCompleted, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, 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, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualizeMethods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, appendProp, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, 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, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getReferencePropNameNoAssert, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParentNoAssert, getTreeLock, hasChanged, hasCircularReferencesError, 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, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, isSibling, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, paramString, 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, warning, warning, warningMethods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, waitMethods 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, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasCircularReferencesError, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, isSibling, 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, warning, warning, warningMethods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized
Field Details
EMPTY_ROWS
An empty array of rows.
Constructor Details
VSRows
public VSRows()Creates a VirtualSpace Rows property with the specified name with a null value.VSRows
Creates an VirtualSpace Rows property with the specified name with a null value.- Parameters:
propertyAtom- The property atom.
Method Details
createRow
Creates a row with a unique name.- Returns:
- A new row with a unique name, not yet added to this row container.
getRows
Gets the rows in this rows container.getTable
Gets the table of the row.- Returns:
- The VirtualSpace Table instance, or null if row is not added to a table.
clone
Clones the property.getRowCount
public int getRowCount()Gets the count of rows.getRow
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
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
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
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
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
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
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 isnull.
removeListener
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.