Package org.pushingpixels.substance.api

Class SubstanceSlices.AnimationFacet

java.lang.Object

org.pushingpixels.substance.api.SubstanceSlices.AnimationFacet

Enclosing class:

SubstanceSlices

public static final class SubstanceSlices.AnimationFacet
extends java.lang.Object

Animation facet.

Field Summary

Fields

Modifier and Type	Field	Description
static SubstanceSlices.AnimationFacet	ARM	Arming a component.
protected java.lang.String	displayName	Animation facet display name.
static SubstanceSlices.AnimationFacet	FOCUS	Focusing a component.
static SubstanceSlices.AnimationFacet	FOCUS_LOOP_ANIMATION	Focus loop animation.
static SubstanceSlices.AnimationFacet	GHOSTING_BUTTON_PRESS	Ghosting image effects on buttons when the button is pressed.
static SubstanceSlices.AnimationFacet	GHOSTING_ICON_ROLLOVER	Ghosting image effects on button icons when the button is rolled-over.
static SubstanceSlices.AnimationFacet	ICON_GLOW	Glow effect on icons when the relevant control is rolled over.
static SubstanceSlices.AnimationFacet	PRESS	Pressing a component.
static SubstanceSlices.AnimationFacet	ROLLOVER	Rollover a component.
static SubstanceSlices.AnimationFacet	SELECTION	Selecting a component.
static SubstanceSlices.AnimationFacet	TREE_SMART_SCROLL_ANIMATION	Smart tree scroll animation facet.

Constructor Summary

Constructors

Constructor	Description
AnimationFacet(java.lang.String displayName, boolean isDefaultAllowed)	Creates a new animation facet.

Method Summary

Modifier and Type	Method	Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

displayName

protected java.lang.String displayName

Animation facet display name.

ARM

public static final SubstanceSlices.AnimationFacet ARM

Arming a component.

PRESS

public static final SubstanceSlices.AnimationFacet PRESS

Pressing a component.

FOCUS

public static final SubstanceSlices.AnimationFacet FOCUS

Focusing a component.

FOCUS_LOOP_ANIMATION

public static final SubstanceSlices.AnimationFacet FOCUS_LOOP_ANIMATION

Focus loop animation. Disabled by default, use SubstanceCortex.GlobalScope.allowAnimations(SubstanceSlices.AnimationFacet) to enable.

ROLLOVER

public static final SubstanceSlices.AnimationFacet ROLLOVER

Rollover a component.

SELECTION

public static final SubstanceSlices.AnimationFacet SELECTION

Selecting a component.

GHOSTING_ICON_ROLLOVER

public static final SubstanceSlices.AnimationFacet GHOSTING_ICON_ROLLOVER

Ghosting image effects on button icons when the button is rolled-over. Disabled by default, use SubstanceCortex.GlobalScope.allowAnimations(SubstanceSlices.AnimationFacet) to enable.

GHOSTING_BUTTON_PRESS

public static final SubstanceSlices.AnimationFacet GHOSTING_BUTTON_PRESS

Ghosting image effects on buttons when the button is pressed. Disabled by default, use SubstanceCortex.GlobalScope.allowAnimations(SubstanceSlices.AnimationFacet) to enable.

ICON_GLOW

public static final SubstanceSlices.AnimationFacet ICON_GLOW

Glow effect on icons when the relevant control is rolled over. Disabled by default, use SubstanceCortex.GlobalScope.allowAnimations(SubstanceSlices.AnimationFacet) to enable.

TREE_SMART_SCROLL_ANIMATION

public static final SubstanceSlices.AnimationFacet TREE_SMART_SCROLL_ANIMATION

Smart tree scroll animation facet. Disabled by default, use SubstanceCortex.GlobalScope.allowAnimations(SubstanceSlices.AnimationFacet) to enable.

Smart tree scroll is relevant for scroll panes containing a tree. When enabled, it automatically scrolls the tree horizontally when the viewport shows mainly empty area (especially relevant for multi-level trees with narrow viewports).

Constructor Detail

AnimationFacet

public AnimationFacet(java.lang.String displayName,
                      boolean isDefaultAllowed)

Creates a new animation facet.

Parameters:

displayName - Display name for the animation facet.

isDefaultAllowed - Indicates whether this animation facet is allowed by default.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object