public class ActionContentModifier
extends java.lang.Object
ActionContentModifier
tells what modifications may be applied to the contents
(e.g. the icon) of a StandardDockAction
. All ActionContentModifier
that are used
by this framework will always be declared as constant in this class. Clients are however free
to add additional modifiers.Modifier and Type | Field and Description |
---|---|
static ActionContentModifier |
DISABLED
the action is disabled.
|
static ActionContentModifier |
DISABLED_HORIZONTAL
the action is disabled, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
DISABLED_HOVER
the action is disabled and the mouse is hovering over the action.
|
static ActionContentModifier |
DISABLED_HOVER_HORIZONTAL
the action is disabled and the mouse is hovering over the action, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
DISABLED_HOVER_VERTICAL
the action is disabled and the mouse is hovering over the action, the action is guaranteed to be shown vertically
|
static ActionContentModifier |
DISABLED_PRESSED
the action is disabled and the mouse is pressed over the action.
|
static ActionContentModifier |
DISABLED_PRESSED_HORIZONTAL
the action is disabled and the mouse is pressed over the action, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
DISABLED_PRESSED_VERTICAL
the action is disabled and the mouse is pressed over the action, the action is guaranteed to be shown vertically
|
static ActionContentModifier |
DISABLED_VERTICAL
the action is disabled, the action is guaranteed to be shown vertically
|
static ActionContentModifier |
NONE
no modifier at all.
|
static ActionContentModifier |
NONE_HORIZONTAL
no modifier at all, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
NONE_HOVER
the mouse is somehow hovering over the action.
|
static ActionContentModifier |
NONE_HOVER_HORIZONTAL
the mouse is somehow hovering over the action, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
NONE_HOVER_VERTICAL
the mouse is somehow hovering over the action, the action is guaranteed to be shown vertically
|
static ActionContentModifier |
NONE_PRESSED
the mouse was pressed over the action.
|
static ActionContentModifier |
NONE_PRESSED_HORIZONTAL
the mouse was pressed over the action, the action is guaranteed to be shown horizontally
|
static ActionContentModifier |
NONE_PRESSED_VERTICAL
the mouse was pressed over the action, the action is guaranteed to be shown vertically
|
static ActionContentModifier |
NONE_VERTICAL
no modifier at all, the action is guaranteed to be shown vertically
|
Constructor and Description |
---|
ActionContentModifier(java.lang.String id,
boolean enabled,
ActionContentModifier... backup)
Creates a new modifier.
|
ActionContentModifier(java.lang.String id,
boolean enabled,
boolean horizontal,
boolean vertical,
ActionContentModifier... backup)
Creates a new modifier.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
ActionContentModifier[] |
getBackup()
Gets the modifiers which should be used if
this is not available. |
int |
hashCode() |
boolean |
isEnabled()
Tells whether the
DockAction is supposed to be enabled
if this modifier is used or not. |
boolean |
isHorizontal()
Tells whether this modifier represents an action that is guaranteed to be shown horizontally.
|
boolean |
isVertical()
Tells whether this modifier represents an action that is guaranteed to be shown vertically.
|
java.lang.String |
toString() |
public static final ActionContentModifier NONE
public static final ActionContentModifier NONE_VERTICAL
public static final ActionContentModifier NONE_HORIZONTAL
public static final ActionContentModifier NONE_HOVER
public static final ActionContentModifier NONE_HOVER_VERTICAL
public static final ActionContentModifier NONE_HOVER_HORIZONTAL
public static final ActionContentModifier NONE_PRESSED
public static final ActionContentModifier NONE_PRESSED_VERTICAL
public static final ActionContentModifier NONE_PRESSED_HORIZONTAL
public static final ActionContentModifier DISABLED
public static final ActionContentModifier DISABLED_VERTICAL
public static final ActionContentModifier DISABLED_HORIZONTAL
public static final ActionContentModifier DISABLED_HOVER
public static final ActionContentModifier DISABLED_HOVER_VERTICAL
public static final ActionContentModifier DISABLED_HOVER_HORIZONTAL
public static final ActionContentModifier DISABLED_PRESSED
public static final ActionContentModifier DISABLED_PRESSED_VERTICAL
public static final ActionContentModifier DISABLED_PRESSED_HORIZONTAL
public ActionContentModifier(java.lang.String id, boolean enabled, ActionContentModifier... backup)
id
- the new modifierenabled
- whether this modifier describes an action which is enabledbackup
- the modifier that applies if this
is not defined. It is the callers
responsibility to ensure, that no cycle of modifiers is built. This argument can be null
.public ActionContentModifier(java.lang.String id, boolean enabled, boolean horizontal, boolean vertical, ActionContentModifier... backup)
id
- the new modifierenabled
- whether this modifier describes an action which is enabledhorizontal
- whether the action is guaranteed to be shown horizontallyvertical
- whether the action is guaranteed to be shown verticallybackup
- the modifier that applies if this
is not defined. It is the callers
responsibility to ensure, that no cycle of modifiers is built. This argument can be null
.public ActionContentModifier[] getBackup()
this
is not available.null
public boolean isEnabled()
DockAction
is supposed to be enabled
if this modifier is used or not.public boolean isHorizontal()
true
if the action is shown horizontally, false
if the orientation is not known
or not horizontalpublic boolean isVertical()
true
if the action is shown vertically, false
if the orientation is not known
or not verticalpublic int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object