Package com.iizix.gyro
Interface ILockUI
- All Known Subinterfaces:
IUIAction
- All Known Implementing Classes:
AbstractUIAction,EditorVSAction,EMLItemProp,EUIButton,EUIImage,EUIMenuItem,MLItemProp,UIButton,UIImage,UIMenuItem,VSAction
Interface providing Lock UI API support used by UI and VirtualSpace actions.
- Author:
- Christopher Mindus
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringProperty name: lock UI, BoolProp, default true.static final StringProperty name: wait message, KStringProp.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_INCLUDE_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATEMethod Summary
Modifier and TypeMethodDescriptiondefault ProgressIndicatorDelayReturns the delay before the hourglass is shown when the UI is locked.default ProgressIndicatorDelaygetProgressIndicatorDelay(ILockUI defaultProvider) Returns the delay before the hourglass is shown when the UI is locked.default KStringReturns the wait message to display alongside the UI lock or progress indicator in the UI (e.g.default KStringgetWaitMessage(ILockUI defaultProvider) Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g.default booleanReturns if the action would lock the UI before execution.default booleanisLockUIEnabled(ILockUI defaultProvider) Returns if the action would lock the UI before execution.default booleansetLockUIEnabled(boolean doLockUI) Sets if the action should lock the UI before the action starts execution.default booleanSets the delay before the hourglass is shown when the UI is locked.default booleansetWaitMessage(KString waitMsg) Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g.default booleansetWaitMessage(String waitMsg) Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g.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, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasCircularReferencesError, 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, isSibling, 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, warning, warning, warningMethods 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, 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
Field Details
LOCK_UI
Property name: lock UI, BoolProp, default true.- See Also:
WAIT_MSG
Property name: wait message, KStringProp.- See Also:
Method Details
isLockUIEnabled
default boolean isLockUIEnabled()Returns if the action would lock the UI before execution.If the UI is not locked, the user could still perform functions in it. Generally this is not a good idea, but sometimes actions can perform some lengthy operation with a progress feed-back.
The default is true.
- Returns:
- true if the UI lock state for the application session should be set or activated, false otherwise.
getWaitMessage
Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g. spinning hourglass).- Returns:
- The wait message, or null for none (just the hourglass is displayed).
getProgressIndicatorDelay
Returns the delay before the hourglass is shown when the UI is locked.- Returns:
- The delay, never null, default NORMAL.
isLockUIEnabled
Returns if the action would lock the UI before execution.The returned value is taken from this instance if defined, otherwise from the defaultProvider (if defined).
If the UI is not locked, the user could still perform functions in it. Generally this is not a good idea, but sometimes actions can perform some lengthy operation with a progress feed-back.
- Parameters:
defaultProvider- If the setting is not provided by this instance and thedefaultProvideris not null, use its default value if the setting is undefined.- Returns:
- true if the UI lock state for the application session should be set or activated, false otherwise.
getWaitMessage
Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g. spinning hourglass).The returned value is taken from this instance if defined, otherwise from the defaultProvider (if defined).
- Parameters:
defaultProvider- If the setting is not provided by this instance and thedefaultProvideris not null, use its default value if the setting is undefined.- Returns:
- The wait message, or null for none (just the hourglass is displayed).
getProgressIndicatorDelay
Returns the delay before the hourglass is shown when the UI is locked.The returned value is taken from this instance if defined, otherwise from the defaultProvider (if defined).
- Parameters:
defaultProvider- If the setting is not provided by this instance and thedefaultProvideris not null, use its default value if the setting is undefined.- Returns:
- The delay, never null, default NORMAL.
setLockUIEnabled
default boolean setLockUIEnabled(boolean doLockUI) Sets if the action should lock the UI before the action starts execution.If the UI is not locked, the user could still perform functions in it. Generally this is not a good idea, but sometimes actions can perform some lengthy operation with a progress feed-back.
- Parameters:
doLockUI- The UI lock state.- Returns:
- true if the value was changed, false otherwise.
setWaitMessage
Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g. spinning hourglass).- Parameters:
waitMsg- The wait message, or null or empty for none (just the hourglass is displayed).- Returns:
- true if the value was changed, false otherwise.
setWaitMessage
Returns the wait message to display alongside the UI lock or progress indicator in the UI (e.g. spinning hourglass).- Parameters:
waitMsg- The wait message, or null or empty for none (just the hourglass is displayed).- Returns:
- true if the value was changed, false otherwise.
setProgressIndicatorDelay
Sets the delay before the hourglass is shown when the UI is locked.- Parameters:
delay- The delay, never null.- Returns:
- true if the value was changed, false otherwise.