Package com.iizix.prop.vs

Interface IVSMessageComponent

All Superinterfaces:

ICustomDataProvider, IFocusComp, IGProp<GProp<?>[]>, IMessageBox, IPropCnr, IVSComponent, IVSComponentListener, IVSComponentState

All Known Implementing Classes:

EditorVirtualSpace, EditorVSAction, EditorVSColumnHeader, EditorVSField, EditorVSTable, VirtualSpace, VSAction, VSColumnHeader, VSField, VSTable

public interface IVSMessageComponent
extends IVSComponent

The message support for a VS component.

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.vs.IVSComponent

ERROR, INFORMATION, NONE, PN_IGNORE_UI_FOCUS, WARNING

Method Summary

Modifier and Type	Method	Description
default boolean	clearMessage()	Clears the message.
default PlainKString	getMessage()	Gets the message from the validation process.
default int	getMessageCategory()	Gets the current message category.
default java.lang.String	getMessageString()	Gets the message from the validation process as a String.
default boolean	isValid()	Checks if valid, i.e.
default boolean	setErrorMessage(java.lang.String message)	Helper method to set (or clear) the error message (message + category IVSComponent.ERROR).
default boolean	setMessage(ValueConversionException exception)	Sets the validation message for a value conversion error.
default boolean	setMessage(PlainKString message, int category)	Sets the validation message.

Methods inherited from interface com.iizix.prop.ICustomDataProvider

forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent

Methods inherited from interface com.iizix.gyro.IFocusComp

onFocusGained, onFocusLost, requestFocus, requestFocus, requestFocusEx, requestFocusEx

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.vs.IVSComponent

getAction, getAction2, getActionNull, getActionNull2, getDescription, getField, getField2, getFieldNull, getFieldNull2, getGroup, getGroup2, getGroupNull, getGroupNull2, getNonVirtualized, getTable, getTable2, getTableNull, getTableNull2, getVirtualizedVirtualSpace, getVirtualSpace, getVSComponent, getVSComponent2, getVSComponentNull, getVSComponentNull2, getVSRef, isEnabled, isEnabledInParent, isReadOnly, isReadOnlyInParent, isSelected, isVisible, isVisibleInParent, messageBox, setEnabled, setEnabled, setIgnoreFocusFromUI, setReadOnly, setReadOnly, setSelected, setSelected, setVirtualizeSupportFocus, setVirtualizeSupportFocus, setVisible, setVisible, shouldIgnoreFocusFromUI

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

onParentStateChanged

Method Detail

isValid

default boolean isValid()

Checks if valid, i.e. no message is present.

Returns:

true if there is no message, false otherwise.

clearMessage

default boolean clearMessage()

Clears the message.

Returns:

true for change, false means no change.

getMessage

default PlainKString getMessage()

Gets the message from the validation process.

Returns:

The message from the parsing or validation, null for none (i.e. OK).

getMessageString

default java.lang.String getMessageString()

Gets the message from the validation process as a String.

Note: the returned string could be empty in case the PlainKString contains tags and the resolved string becomes empty!

Returns:

The message from the parsing or validation, null for none (i.e. OK).

getMessageCategory

default int getMessageCategory()

Gets the current message category.

Returns:

Always IVSComponent.NONE (-1) when valid, otherwise IVSComponent.INFORMATION (0), IVSComponent.WARNING (1) or IVSComponent.ERROR (2).

setMessage

default boolean setMessage(ValueConversionException exception)

Sets the validation message for a value conversion error.

Parameters:

exception - The value conversion exception.

Returns:

true for change, false means no change.

setMessage

default boolean setMessage(PlainKString message,
                           int category)

Sets the validation message.

Parameters:

message - The message to set, null to clear message (category will not be changed).

category - The message category IVSComponent.NONE (-1), IVSComponent.INFORMATION (0), IVSComponent.WARNING (1) or IVSComponent.ERROR (2).

Returns:

true for change, false for no change.

Throws:

java.lang.IllegalArgumentException - If the category is not IVSComponent.NONE (-1), IVSComponent.INFORMATION (0), IVSComponent.WARNING (1) or IVSComponent.ERROR (2).

setErrorMessage

default boolean setErrorMessage(java.lang.String message)

Helper method to set (or clear) the error message (message + category IVSComponent.ERROR).

Parameters:

message - The message.

Returns:

true for change, false for no change.