com.iizix.prop.ui.selection

Interface IUISelectionComp

All Superinterfaces:

IComponent, ICustomDataProvider, IGProp<GProp<?>[]>, IMessageBox, IPropCnr, IUIComp, IVSComponentListener, IVSComponentState, IVSFieldListener

All Known Subinterfaces:

IUIAnimatedSingleIndexedSelectionComp, IUIBooleanSelectionComp, IUICellSelectionComp, IUICheck2Component, IUICheckComponent, IUIIndexedSelectionComp, IUIRadioComponent, IUISingleIndexedSelectionComp, IUITriStateSelectionComp

All Known Implementing Classes:

AbstractContentUIContainer, EMapMarkerProp, EMapMarkers, EMLGroup, EMLItemProp, EMUISwitch, EUIAccordion, EUICheckBox, EUICheckedMenuItem, EUIComboBox, EUIRadioButton, EUIRadioMenuItem, EUISpinner, EUISwapContainer, EUITabContainer, EUITable, EUITitlePane, MapMarkerProp, MapMarkers, MLGroup, MLItemProp, MUISwitch, UIAbstractListChoice, UIAccordion, UICheckBox, UICheckedMenuItem, UIComboBox, UIRadioButton, UIRadioMenuItem, UISpinner, UISwapContainer, UITabContainer, UITable, UITitlePane

public interface IUISelectionComp
extends IUIComp

Interface implements by components that process selection and emits selection events.

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

Modifier and Type	Field and Description
static int	SELECTION_TYPE_MULTIPLE Selection type: MULTIPLE.
static int	SELECTION_TYPE_NONE Selection type: NONE.
static int	SELECTION_TYPE_SINGLE Selection type: SINGLE.

Fields inherited from interface com.iizix.prop.ui.IUIComp

ERROR, INFORMATION, NONE, REMOTE_FOCUS_EVENT, WARNING

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

Method Summary

Modifier and Type	Method and Description
default boolean	addSelectionListener(IUISelectionListener listener) Adds a selection listener.
Method	getOnUISelectionMethod() Returns the method to use for onUISelection notifications that is attached to this selection component.
IUISelection	getSelection() Gets the current selection of the component.
GenericListener<IUISelectionListener>	getSelectionListenerHandler(boolean doCreate) Returns the generic selection listener.
Atom	getSelectionPropAtom() Returns the selection property atom for verification of selection changes.
int	getSelectionType() Gets the selection type of the component.
boolean	isSelected() Returns the selection of state of the component.
default boolean	isSelectionBooleanBased() Returns if the selection component supports boolean based selection.
default boolean	isSelectionCellBased() Returns if the selection component supports is cell based.
default boolean	isSelectionIndexBased() Returns if the selection component supports index-based selection.
default boolean	isSelectionTriStateBased() Returns if the selection component supports tri-state based selection for e.g.
default boolean	removeSelectionListener(IUISelectionListener listener) Removes a selection listener.
default String	setSelection(IUISelection selection) Sets the selection.

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.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.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, 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, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, 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.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, 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.vs.IVSFieldListener

getBestVSFieldValueType, onBroken, onResolved, onStateChanged, onValueChanged

Methods inherited from interface com.iizix.prop.vs.IVSComponentListener

onParentStateChanged

Methods inherited from interface com.iizix.prop.ICustomDataProvider

forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent

Field Detail

SELECTION_TYPE_NONE

static final int SELECTION_TYPE_NONE

Selection type: NONE.

See Also:

Constant Field Values

SELECTION_TYPE_SINGLE

static final int SELECTION_TYPE_SINGLE

Selection type: SINGLE.

This value is returned by radio buttons, check boxes, comboboxes, tab containers, and single-selection grids.

See Also:

Constant Field Values

SELECTION_TYPE_MULTIPLE

static final int SELECTION_TYPE_MULTIPLE

Selection type: MULTIPLE.

This value is returned from e.g. the grid when in multiple, extended or toggle selection modes.

See Also:

Constant Field Values

Method Detail

getSelectionPropAtom

Atom getSelectionPropAtom()

Returns the selection property atom for verification of selection changes.

This method is used by the framework in UIComp to fire selection events when the property value changes.

Returns:

The atom of the selection property, or null if a selection property is not used.

getSelectionListenerHandler

GenericListener<IUISelectionListener> getSelectionListenerHandler(boolean doCreate)

Returns the generic selection listener.

Parameters:

doCreate - Create the listener handler if it doesn't exist, false not to.

Returns:

The selection listener handler, or null if not created.

addSelectionListener

default boolean addSelectionListener(IUISelectionListener listener)

Adds a selection listener.

Parameters:

listener - The listener.

Returns:

true for success, false if the listener is already added.

Throws:

NullPointerException - If listener is null.

removeSelectionListener

default boolean removeSelectionListener(IUISelectionListener listener)

Removes a selection listener.

Parameters:

listener - The listener.

Returns:

true for success, false if the listener has not been added before.

Throws:

NullPointerException - If listener is null.

getSelectionType

int getSelectionType()

Gets the selection type of the component.

Returns:

A value indicating the selection capability as the SELECTION_TYPE_* values define.

isSelected

boolean isSelected()

Returns the selection of state of the component.

For a multiple-selection capable component, this indicates any selection, i.e. true is returned as soon as at least one element is selected, false for none.

The checkbox for example has two "selected states": checked and third state: in this case, true is returned for the third state as well as the checked state.

Returns:

true if the component is selected, false otherwise.

isSelectionBooleanBased

default boolean isSelectionBooleanBased()

Returns if the selection component supports boolean based selection.

Returns:

true if the selection can be retrieved or set using indexed based selections.

isSelectionTriStateBased

default boolean isSelectionTriStateBased()

Returns if the selection component supports tri-state based selection for e.g. checkboxes.

Returns:

true if the selection can be retrieved or set using indexed based selections.

isSelectionIndexBased

default boolean isSelectionIndexBased()

Returns if the selection component supports index-based selection.

Returns:

true if the selection can be retrieved or set using indexed based selections.

isSelectionCellBased

default boolean isSelectionCellBased()

Returns if the selection component supports is cell based.

Returns:

true if the selection can be retrieved or set using cell based selections.

getSelection

IUISelection getSelection()

Gets the current selection of the component.

Returns:

The current selection of the component.

setSelection

default String setSelection(IUISelection selection)

Sets the selection.

Parameters:

selection - The selection.

Returns:

null if selection is set successfully, otherwise the reason why the selection failed to be set, e.g. "Unsupported selection base" if the selection is indexed for a checkbox that only supports tri-state based selections.

getOnUISelectionMethod

Method getOnUISelectionMethod()

Returns the method to use for onUISelection notifications that is attached to this selection component. The method name is not important, but must have the annotation and signature:

@OnUISelection(name = "some/property")
public void onUISelection(UISelectionEvent event)

Returns:

The method, or null if none is registered.