All Superinterfaces:
IGProp<GProp<?>[]>, IPropCnr
All Known Subinterfaces:
IUIAction
All Known Implementing Classes:
AbstractUIAction, EditorVSAction, EMLItemProp, EMUISimpleDialog, EUIButton, EUIDialog, EUIImage, EUIMenuItem, EUIPanel, EUIPanelPart, MLItemProp, MUISimpleDialog, UIButton, UIDialog, UIImage, UIMenuItem, UIPanel, UIPanelBase, UIPanelPart, VSAction
```
public interface IUIPanelAnimation
extends IPropCnr
```
Interface providing the API to manipulate panel animations when panels are replaced by another. The animation provides a type and a speed. A panel that has been displayed using an animation uses the opposite animation when going back to the previous panel.
Author:
Christopher Mindus

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`IUIPanelAnimation.Direction`	The animation direction.
`static class`	`IUIPanelAnimation.Speed`	The animation speed.
`static class`	`IUIPanelAnimation.Type`	The animation type.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ANIMATION_DEFAULT`	The animation composite value: default (-1).
`static int`	`ANIMATION_FADE_FAST`	The animation composite value: fade fast (1).
`static int`	`ANIMATION_FADE_NORMAL`	The animation composite value: fade normal (10).
`static int`	`ANIMATION_FADE_SLOW`	The animation composite value: fade slow (1).
`static int`	`ANIMATION_FADE_SLOWER`	The animation composite value: fade slower (1000).
`static int`	`ANIMATION_FADE_SLOWEST`	The animation composite value: fade slowest (10000), not recommended, use for testing purposes only.
`static int`	`ANIMATION_NO_CSS3_FLAG`	Animation bit to add to remove CSS3 animations.
`static int`	`ANIMATION_NO_SCROLL_FLAG`	Animation bit to add to remove Scroll animations.
`static int`	`ANIMATION_NONE`	The animation composite value: none (0).
`static java.lang.String`	`ANIMATION_PROP_NAME`	The animation property name "animation".
`static int`	`ANIMATION_SPEED_FAST`	Animation speed: fast (100 ms).
`static int`	`ANIMATION_SPEED_NORMAL`	Animation speed: normal (350 ms).
`static int`	`ANIMATION_SPEED_SLOW`	Animation speed: slow (600 ms).
`static int`	`ANIMATION_SPEED_SLOWER`	Animation speed: slower (1 second).
`static int`	`ANIMATION_SPEED_SLOWEST`	Animation speed: slowest (10 seconds).
`static int`	`ANIMATION_TYPE_COVER`	Animation type: cover.
`static int`	`ANIMATION_TYPE_FADE`	Animation type: fade.
`static int`	`ANIMATION_TYPE_NONE`	Animation type: none.
`static int`	`ANIMATION_TYPE_REVEAL`	Animation type: reveal.
`static int`	`ANIMATION_TYPE_SLIDE`	Animation type: slide.

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`getAnimation()`	Gets the currently defined animation when this panel is going to be replaced.
`default int`	`getAnimation(int defaultAnimation)`	Gets the currently defined animation when this panel is going to be replaced.
`default java.lang.String`	`getAnimationDescription()`	Gets the animation description as a "debug" string.
`static java.lang.String`	`getAnimationDescription(int animation)`	Gets the animation description as a "debug" string.
`default IUIPanelAnimation.Direction`	`getAnimationDirection()`	Gets the animation direction.
`default IUIPanelAnimation.Speed`	`getAnimationSpeed()`	Gets the animation speed.
`default IUIPanelAnimation.Type`	`getAnimationType()`	Gets the animation type.
`static int`	`getAnimationValue(int type, int direction, int speed)`	Gets the animation value.
`static int`	`getAnimationValue(IUIPanelAnimation.Type type, IUIPanelAnimation.Direction direction, IUIPanelAnimation.Speed speed)`	Gets the animation value.
`static int`	`getOppositeAnimation(int animation)`	Gets the opposite animation composite value from an animation composite value, i.e.
`boolean`	`isAnimationPropPrivate()`	Returns if the animation property is private or not.
`default boolean`	`setAnimation(int animation)`	Sets the animation when a panel is replaced by another.
`default boolean`	`setAnimation(IUIPanelAnimation.Type type, IUIPanelAnimation.Direction direction, IUIPanelAnimation.Speed speed)`	Sets the animation when a panel is replaced by another.

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

- Field Detail
  - ANIMATION_PROP_NAME
```
static final java.lang.String ANIMATION_PROP_NAME
```
    The animation property name "animation".
    See Also:
    Constant Field Values
  - ANIMATION_NO_CSS3_FLAG
```
static final int ANIMATION_NO_CSS3_FLAG
```
    Animation bit to add to remove CSS3 animations.
    See Also:
    Constant Field Values
  - ANIMATION_NO_SCROLL_FLAG
```
static final int ANIMATION_NO_SCROLL_FLAG
```
    Animation bit to add to remove Scroll animations.
    See Also:
    Constant Field Values
  - ANIMATION_DEFAULT
```
static final int ANIMATION_DEFAULT
```
    The animation composite value: default (-1).
    See Also:
    Constant Field Values
  - ANIMATION_NONE
```
static final int ANIMATION_NONE
```
    The animation composite value: none (0).
    See Also:
    Constant Field Values
  - ANIMATION_FADE_FAST
```
static final int ANIMATION_FADE_FAST
```
    The animation composite value: fade fast (1).
    See Also:
    Constant Field Values
  - ANIMATION_FADE_NORMAL
```
static final int ANIMATION_FADE_NORMAL
```
    The animation composite value: fade normal (10).
    See Also:
    Constant Field Values
  - ANIMATION_FADE_SLOW
```
static final int ANIMATION_FADE_SLOW
```
    The animation composite value: fade slow (1).
    See Also:
    Constant Field Values
  - ANIMATION_FADE_SLOWER
```
static final int ANIMATION_FADE_SLOWER
```
    The animation composite value: fade slower (1000).
    See Also:
    Constant Field Values
  - ANIMATION_FADE_SLOWEST
```
static final int ANIMATION_FADE_SLOWEST
```
    The animation composite value: fade slowest (10000), not recommended, use for testing purposes only.
    See Also:
    Constant Field Values
  - ANIMATION_TYPE_NONE
```
static final int ANIMATION_TYPE_NONE
```
    Animation type: none.
    See Also:
    Constant Field Values
  - ANIMATION_TYPE_FADE
```
static final int ANIMATION_TYPE_FADE
```
    Animation type: fade.
    See Also:
    Constant Field Values
  - ANIMATION_TYPE_SLIDE
```
static final int ANIMATION_TYPE_SLIDE
```
    Animation type: slide.
    See Also:
    Constant Field Values
  - ANIMATION_TYPE_COVER
```
static final int ANIMATION_TYPE_COVER
```
    Animation type: cover.
    See Also:
    Constant Field Values
  - ANIMATION_TYPE_REVEAL
```
static final int ANIMATION_TYPE_REVEAL
```
    Animation type: reveal.
    See Also:
    Constant Field Values
  - ANIMATION_SPEED_FAST
```
static final int ANIMATION_SPEED_FAST
```
    Animation speed: fast (100 ms).
    See Also:
    Constant Field Values
  - ANIMATION_SPEED_NORMAL
```
static final int ANIMATION_SPEED_NORMAL
```
    Animation speed: normal (350 ms).
    See Also:
    Constant Field Values
  - ANIMATION_SPEED_SLOW
```
static final int ANIMATION_SPEED_SLOW
```
    Animation speed: slow (600 ms).
    See Also:
    Constant Field Values
  - ANIMATION_SPEED_SLOWER
```
static final int ANIMATION_SPEED_SLOWER
```
    Animation speed: slower (1 second).
    See Also:
    Constant Field Values
  - ANIMATION_SPEED_SLOWEST
```
static final int ANIMATION_SPEED_SLOWEST
```
    Animation speed: slowest (10 seconds). Do not use this speed, it is intended for testing.
    See Also:
    Constant Field Values
- Method Detail
  - getAnimationValue
```
static int getAnimationValue(IUIPanelAnimation.Type type,
                             IUIPanelAnimation.Direction direction,
                             IUIPanelAnimation.Speed speed)
```
    Gets the animation value.
    Parameters:
    type - The animation type.
    direction - The direction.
    speed - The speed.
    Returns:
    The integer direction value.
    Throws:
    java.lang.IllegalArgumentException - For invalid parameters.
  - getAnimationValue
```
static int getAnimationValue(int type,
                             int direction,
                             int speed)
```
    Gets the animation value.
    Parameters:
    type - The animation type ANIMATION_TYPE_nnn values.
    direction - The direction is 4=left, 6=right, 8=up, 2=down (used for directional types only).
    speed - The speed is ANIMATION_SPEED_nnn values.
    Throws:
    java.lang.IllegalArgumentException - For invalid parameters.
  - getOppositeAnimation
```
static int getOppositeAnimation(int animation)
```
    Gets the opposite animation composite value from an animation composite value, i.e. if an animation is slide right, the opposite is slide left, reveal opposite of cover with opposite direction, etc.
    Parameters:
    animation - The animation composite value.
    Returns:
    The opposite animation composite value, or ANIMATION_DEFAULT if no opposite is found.
  - setAnimation
```
default boolean setAnimation(int animation)
```
    Sets the animation when a panel is replaced by another.
    This call must be made prior to the panel removal and can be called programmatically. This method is also called for e.g. UI actions that also can specify the panel animation.
    Parameters:
    animation - The animation composite value: values ANIMATION_*.
    Returns:
    true for change, false for no change.
  - isAnimationPropPrivate
```
boolean isAnimationPropPrivate()
```
    Returns if the animation property is private or not.
    Returns:
    Typically true for actions, false for panels.
  - setAnimation
```
default boolean setAnimation(IUIPanelAnimation.Type type,
                             IUIPanelAnimation.Direction direction,
                             IUIPanelAnimation.Speed speed)
```
    Sets the animation when a panel is replaced by another.
    This call must be made prior to the panel removal and can be called programmatically. This method is also called for e.g. UI actions that also can specify the panel animation.
    The animation types NONE and FADE are not affected by direction, but the parameter cannot be null.
    Parameters:
    type - The animation type.
    direction - The animation direction.
    speed - The animation speed.
    Returns:
    true for change, false for no change.
  - getAnimation
```
default int getAnimation()
```
    Gets the currently defined animation when this panel is going to be replaced.
    Returns:
    The animation composite value, or ANIMATION_DEFAULT if none other is defined.
  - getAnimation
```
default int getAnimation(int defaultAnimation)
```
    Gets the currently defined animation when this panel is going to be replaced.
    Parameters:
    defaultAnimation - The default animation to use if not defined.
    Returns:
    The animation composite value, or the defaultAnimation if none other is defined.
  - getAnimationType
```
default IUIPanelAnimation.Type getAnimationType()
```
    Gets the animation type.
    Returns:
    The animation type, defaults to NONE.
  - getAnimationDirection
```
default IUIPanelAnimation.Direction getAnimationDirection()
```
    Gets the animation direction.
    Returns:
    The animation direction, defaults to RIGHT.
  - getAnimationSpeed
```
default IUIPanelAnimation.Speed getAnimationSpeed()
```
    Gets the animation speed.
    Returns:
    The animation speed, defaults to NORMAL.
  - getAnimationDescription
```
default java.lang.String getAnimationDescription()
```
    Gets the animation description as a "debug" string.
    Returns:
    The string.
  - getAnimationDescription
```
static java.lang.String getAnimationDescription(int animation)
```
    Gets the animation description as a "debug" string.
    Parameters:
    animation - The composite animation value.
    Returns:
    The string.

Interface IUIPanelAnimation

Nested Class Summary

Field Summary

Fields inherited from interface com.iizix.prop.IGProp

Method Summary

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Field Detail

ANIMATION_PROP_NAME

ANIMATION_NO_CSS3_FLAG

ANIMATION_NO_SCROLL_FLAG

ANIMATION_DEFAULT

ANIMATION_NONE

ANIMATION_FADE_FAST

ANIMATION_FADE_NORMAL

ANIMATION_FADE_SLOW

ANIMATION_FADE_SLOWER

ANIMATION_FADE_SLOWEST

ANIMATION_TYPE_NONE

ANIMATION_TYPE_FADE

ANIMATION_TYPE_SLIDE

ANIMATION_TYPE_COVER

ANIMATION_TYPE_REVEAL

ANIMATION_SPEED_FAST

ANIMATION_SPEED_NORMAL

ANIMATION_SPEED_SLOW

ANIMATION_SPEED_SLOWER

ANIMATION_SPEED_SLOWEST

Method Detail

getAnimationValue

getAnimationValue

getOppositeAnimation

setAnimation

isAnimationPropPrivate

setAnimation

getAnimation

getAnimation

getAnimationType

getAnimationDirection

getAnimationSpeed

getAnimationDescription

getAnimationDescription