Package com.iizix.prop.ui.selection
Interface IUIIndexedSelectionComp
- All Superinterfaces:
IComponent,ICustomDataProvider,IGProp<GProp<?>[]>,IMessageBox,IPropCnr,IUIComp,IUISelectionComp,IVSComponentListener,IVSComponentState,IVSFieldListener
- All Known Subinterfaces:
IUIAnimatedSingleIndexedSelectionComp,IUIRadioComponent,IUISingleIndexedSelectionComp
- All Known Implementing Classes:
AbstractContentUIContainer,EMapMarkers,EMLGroup,EUIAccordion,EUIComboBox,EUIRadioButton,EUIRadioMenuItem,EUISpinner,EUISwapContainer,EUITabContainer,EUITable,MapMarkers,MLGroup,UIAbstractListChoice,UIAccordion,UIComboBox,UIRadioButton,UIRadioMenuItem,UISpinner,UISwapContainer,UITabContainer,UITable
public interface IUIIndexedSelectionComp extends IUISelectionComp
The interface for a selection component supporting index-based selections.- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox
IMessageBox.Icon
Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState
IVSComponentState.State
Field Summary
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
Fields inherited from interface com.iizix.gyro.IMessageBox
ICON_ERROR, ICON_INFORMATION, ICON_MAP, ICON_NONE, ICON_QUESTION, ICON_WARNING
Fields inherited from interface com.iizix.prop.ui.IUIComp
ERROR, INFORMATION, NONE, REMOTE_FOCUS_EVENT, WARNING
Fields inherited from interface com.iizix.prop.ui.selection.IUISelectionComp
SELECTION_TYPE_MULTIPLE, SELECTION_TYPE_NONE, SELECTION_TYPE_SINGLE
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.StringclearSelection()Clear the selection.intgetFirstSelectedIndex()Gets the first selected index.int[]getSelectedIndicies()Gets the selected indicies.default booleanisSelectionIndexBased()Returns if the selection component supports index-based selection.java.lang.StringsetSelection(int index)Sets the selection as a single selected item at specified index.java.lang.StringsetSelection(int[] indicies)Sets the selection to the specified indicies.default java.lang.StringsetSelection(IntArrayList intArrayList)Sets the selection to the specified indicies.default java.lang.StringsetSelection(java.lang.Iterable<java.lang.Integer> indiciesIterable)Sets the selection to the specified indicies.default java.lang.StringsetSelection(java.util.Collection<java.lang.Integer> indiciesCollection)Sets the selection to the specified indicies.default java.lang.StringsetSelection(java.util.Iterator<java.lang.Integer> indiciesIterator)Sets the selection to the specified indicies.default java.lang.StringsetSelection(java.util.List<java.lang.Integer> indiciesCollection)Sets the selection to the specified indicies.Methods inherited from interface com.iizix.IComponent
clearErrorMessage, getBadge, getKStringText, getLayoutMgr, getMessage, getMessageText, getStyles, getText, getTooltip, getTooltipText, getUIPanel, getUIParent, isEnabled, isReadOnly, isVisible, messageBox, requestFocus, requestFocus, requestFocusEx, requestFocusEx, setBadge, setBadge, setEnabled, setErrorMessage, setErrorMessage, setHTMLText, setLayoutMgr, setMessage, setMessage, setReadOnly, setText, setText, setTooltip, setTooltip, setVisible
Methods inherited from interface com.iizix.prop.ICustomDataProvider
forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent
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, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning
Methods inherited from interface com.iizix.gyro.IMessageBox
messageBox, messageBox
Methods inherited from interface com.iizix.prop.IPropCnr
addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, 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, usePropHashMap, usesPropIndex, validateClassInstances
Methods inherited from interface com.iizix.prop.ui.IUIComp
canAcceptUIContainerFocus, disconnectVSField, getComponentID, getComponentMappings, getDeviceType, getErrorMessage, getErrorMessage, getFirstUIComponent, getFirstUIComponentNull, getFixHeight, getFixWidth, getLayout, getLayoutMgr, getPanelUIComponent, getPanelUIComponentNull, getUIRef, getValue, getValue, getVirtualSpace, getVSField, isMobile, isRTL, isVSFieldDisconnected, reconnectVSField, setComponentToVSField, setErrorMessage, setErrorMessage, setUIContainerFocus, setVSFieldMessageToComponent, setVSFieldToComponent
Methods inherited from interface com.iizix.prop.ui.selection.IUISelectionComp
addSelectionListener, getOnUISelectionMethod, getSelection, getSelectionListenerHandler, getSelectionPropAtom, getSelectionType, isSelected, isSelectionBooleanBased, isSelectionCellBased, isSelectionTriStateBased, removeSelectionListener, setSelection
Methods inherited from interface com.iizix.prop.vs.IVSComponentListener
onParentStateChanged
Methods inherited from interface com.iizix.prop.vs.IVSFieldListener
getBestVSFieldValueType, onBroken, onResolved, onStateChanged, onValueChanged
Method Detail
clearSelection
java.lang.String clearSelection()
Clear the selection.- Returns:
- null for success, otherwise the error message with the reason why it failed.
getFirstSelectedIndex
int getFirstSelectedIndex()
Gets the first selected index.- Returns:
- The first index in the current selection, or -1 for none.
getSelectedIndicies
int[] getSelectedIndicies()
Gets the selected indicies.- Returns:
- A new array of the selected indices (that may be modified to your liking), or a static zero in length array for no selection.
setSelection
java.lang.String setSelection(int index)
Sets the selection as a single selected item at specified index.- Parameters:
index- The single item to select at index, -1 to clear the selection.- Returns:
- null for success, otherwise an error message why the selection failed.
setSelection
java.lang.String setSelection(int[] indicies)
Sets the selection to the specified indicies.- Parameters:
indicies- The indicies.- Returns:
- null for success, otherwise the error message with the reason why it failed.
setSelection
default java.lang.String setSelection(IntArrayList intArrayList)
Sets the selection to the specified indicies.- Parameters:
intArrayList- The int array of the selection.- Returns:
- null for success, otherwise the error message with the reason why it failed.
setSelection
default java.lang.String setSelection(java.util.List<java.lang.Integer> indiciesCollection)
Sets the selection to the specified indicies.- Parameters:
indiciesCollection- The collection of integers of the selection.- Returns:
- null for success, otherwise the error message with the reason why it failed.
- Throws:
java.lang.NullPointerException- If an element in the collection is null.
setSelection
default java.lang.String setSelection(java.util.Collection<java.lang.Integer> indiciesCollection)
Sets the selection to the specified indicies.- Parameters:
indiciesCollection- The indicies.- Returns:
- null for success, otherwise the error message with the reason why it failed.
- Throws:
java.lang.NullPointerException- If an element in the collection is null.
setSelection
default java.lang.String setSelection(java.lang.Iterable<java.lang.Integer> indiciesIterable)
Sets the selection to the specified indicies.- Parameters:
indiciesIterable- The iterable is used to set the selection to the remaining indicies.- Returns:
- null for success, otherwise the error message with the reason why it failed.
- Throws:
java.lang.NullPointerException- If an element in the iterable elements is null.
setSelection
default java.lang.String setSelection(java.util.Iterator<java.lang.Integer> indiciesIterator)
Sets the selection to the specified indicies.- Parameters:
indiciesIterator- The iterator is used to set the selection to the remaining indicies.- Returns:
- null for success, otherwise the error message with the reason why it failed.
- Throws:
java.lang.NullPointerException- If an element from the iteration over the iterator is null.
isSelectionIndexBased
default boolean isSelectionIndexBased()
Returns if the selection component supports index-based selection.- Specified by:
isSelectionIndexBasedin interfaceIUISelectionComp- Returns:
- true.