Package com.iizix.prop.ui

Interface IUICheck2Component

All Superinterfaces:

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

All Known Implementing Classes:

EMUISwitch, MUISwitch

public interface IUICheck2Component
extends IUIBooleanSelectionComp

Components with check state implement this interface without third state possibility.

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	Description
static Atom	CHECKED_ATOM	The atom name: checked.
static java.lang.String	PN_CHECK_NO_MATCH	Property name: check state for non-matching values.
static java.lang.String	PN_CHECKED	Property name: checked.
static java.lang.String	PN_CHECKED_VALUE	Property name: checked value.
static java.lang.String	PN_UNCHECKED_VALUE	Property name: unchecked value.

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

Modifier and Type	Method	Description
default int	getCheckState()	Gets the check state.
default IUISelection	getSelection()	Gets the current selection of the component.
default int	getSelectionType()	Gets the selection type of the component.
default boolean	isChecked()	Verifies if the component is checked.
default boolean	isOFF()	Returns if the selection is "off".
default boolean	isON()	Returns if the selection is "on".
default boolean	isSelected()	Returns the selection state.
default boolean	isUnselected()	Returns if the selection is not set.
default boolean	setChecked(boolean on)	Sets the checked state.
default boolean	setChecked(int state)	Sets the checked state.
default boolean	setSelection(boolean isSelected)	Sets the selection.
default java.lang.String	setSelection(IUISelection selection)	Sets the selection.

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, 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, 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.ui.selection.IUIBooleanSelectionComp

isSelectionBooleanBased

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, getSelectionListenerHandler, getSelectionPropAtom, isSelectionCellBased, isSelectionIndexBased, isSelectionTriStateBased, removeSelectionListener

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

onParentStateChanged

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

getBestVSFieldValueType, onBroken, onResolved, onStateChanged, onValueChanged

Field Detail

PN_CHECKED

static final java.lang.String PN_CHECKED

Property name: checked.

See Also:

Constant Field Values

CHECKED_ATOM

static final Atom CHECKED_ATOM

The atom name: checked.

PN_CHECKED_VALUE

static final java.lang.String PN_CHECKED_VALUE

Property name: checked value.

See Also:

Constant Field Values

PN_UNCHECKED_VALUE

static final java.lang.String PN_UNCHECKED_VALUE

Property name: unchecked value.

See Also:

Constant Field Values

PN_CHECK_NO_MATCH

static final java.lang.String PN_CHECK_NO_MATCH

Property name: check state for non-matching values.

See Also:

Constant Field Values

Method Detail

getCheckState

default int getCheckState()

Gets the check state.

Third state is not supported.

Returns:

Returns 0=unchecked, 1=checked.

isChecked

default boolean isChecked()

Verifies if the component is checked.

Returns:

true if the component is checked, false if unselected or in third state.

isSelected

default boolean isSelected()

Returns the selection state.

Specified by:

isSelected in interface IUIBooleanSelectionComp

Specified by:

isSelected in interface IUISelectionComp

Returns:

true if selected, false if unselected.

isUnselected

default boolean isUnselected()

Returns if the selection is not set.

Specified by:

isUnselected in interface IUIBooleanSelectionComp

Returns:

true if unselected, true if selected.

isON

default boolean isON()

Returns if the selection is "on".

Specified by:

isON in interface IUIBooleanSelectionComp

Returns:

true if on, false otherwise.

isOFF

default boolean isOFF()

Returns if the selection is "off".

Specified by:

isOFF in interface IUIBooleanSelectionComp

Returns:

true if off, true otherwise.

setChecked

default boolean setChecked(boolean on)

Sets the checked state.

Parameters:

on - The check state.

Returns:

true if state is changed, false for no change.

setChecked

default boolean setChecked(int state)

Sets the checked state.

Parameters:

state - The check state: 0=unchecked, 1=checked.

Third state is not supported.

Returns:

true if state is changed, false for no change or failure (state has wrong value).

setSelection

default boolean setSelection(boolean isSelected)

Sets the selection.

Specified by:

setSelection in interface IUIBooleanSelectionComp

Parameters:

isSelected - The selected state.

Returns:

true if state is changed, false for no change.

getSelectionType

default int getSelectionType()

Gets the selection type of the component.

Specified by:

getSelectionType in interface IUISelectionComp

Returns:

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

getSelection

default IUISelection getSelection()

Gets the current selection of the component.

Specified by:

getSelection in interface IUISelectionComp

Returns:

The current selection of the component.

setSelection

default java.lang.String setSelection(IUISelection selection)

Sets the selection.

Specified by:

setSelection in interface IUISelectionComp

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.