public class LocationHint
extends java.lang.Object
DockActionSource
in respect to other sources. How to interpret
the LocationHint is up to the ActionOffer
which creates the
final DockActionSource
for a Dockable
.Modifier and Type | Class and Description |
---|---|
static class |
LocationHint.Enumeration
Base-class for Enumerations (sets of uniquely identified objects).
|
static class |
LocationHint.Hint
Describes the preferred location of a
LocationHint |
static class |
LocationHint.Origin
Describes who created a
LocationHint |
Modifier and Type | Field and Description |
---|---|
static LocationHint.Origin |
ACTION_GUARD
Used if this hint was produced by an
ActionGuard |
static LocationHint.Origin |
ACTION_OFFER
Used if this hint was produced by an
ActionOffer |
static LocationHint.Origin |
DIRECT_ACTION
Used if this hint was produced by the parent of a dockable
|
static LocationHint.Origin |
DOCKABLE
Used if this hint was produced by a
Dockable |
static LocationHint.Origin |
INDIRECT_ACTION
Used if this hint was produced by one of the parents of a dockable
|
static LocationHint.Hint |
LEFT
Used to indicate that this hint likes to stay left of the middle
|
static LocationHint.Hint |
LEFT_OF_ALL
Used to indicate that this hint likes to stay as left as possible
|
static LocationHint.Hint |
LITTLE_LEFT
Used to indicate that this hint likes to stay a bit left of the middle
|
static LocationHint.Hint |
LITTLE_RIGHT
Used to indicate that this hint likes to stay a bit right of the middle
|
static LocationHint.Hint |
MIDDLE
Used to indicate that this hint likes to stay in the middle
|
static LocationHint.Hint |
RIGHT
Used to indicate that this hint likes to stay right of the middle
|
static LocationHint.Hint |
RIGHT_OF_ALL
Used to indicate that this hint likes to stay as right as possible
|
static LocationHint |
UNKNOWN
The default-location-hint does not know anything
|
static LocationHint.Hint |
UNKNOWN_HINT
Used to indicate that this hint does not know where to stay
|
static LocationHint.Origin |
UNKNOWN_ORIGIN
Used if it is unclear who produced this hint
|
static LocationHint.Hint |
VERY_LEFT
Used to indicate that this hint likes to stay at the left side
|
static LocationHint.Hint |
VERY_RIGHT
Used to indicate that this hint likes to stay at the right side
|
Constructor and Description |
---|
LocationHint(LocationHint.Hint hint)
Creates a new LocationHint.
|
LocationHint(LocationHint.Origin origin)
Creates a new LocationHint.
|
LocationHint(LocationHint.Origin origin,
LocationHint.Hint hint)
Creates a new LocationHint.
|
LocationHint(LocationHint.Origin origin,
LocationHint.Hint hint,
java.lang.Object clientObject)
Creates a new LocationHint.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getClientObject()
Gets the object which has no special meaning.
|
LocationHint.Hint |
getHint()
Gets the preferred location of this hint.
|
LocationHint.Origin |
getOrigin()
Gets the origin of this hint.
|
void |
setClientObject(java.lang.Object clientObject)
Sets an object which has no special meaning.
|
public static final LocationHint.Origin DOCKABLE
Dockable
public static final LocationHint.Origin ACTION_GUARD
ActionGuard
public static final LocationHint.Origin DIRECT_ACTION
public static final LocationHint.Origin INDIRECT_ACTION
public static final LocationHint.Origin ACTION_OFFER
ActionOffer
public static final LocationHint.Origin UNKNOWN_ORIGIN
public static final LocationHint.Hint LEFT_OF_ALL
public static final LocationHint.Hint VERY_LEFT
public static final LocationHint.Hint LEFT
public static final LocationHint.Hint LITTLE_LEFT
public static final LocationHint.Hint MIDDLE
public static final LocationHint.Hint LITTLE_RIGHT
public static final LocationHint.Hint RIGHT
public static final LocationHint.Hint VERY_RIGHT
public static final LocationHint.Hint RIGHT_OF_ALL
public static final LocationHint.Hint UNKNOWN_HINT
public static final LocationHint UNKNOWN
public LocationHint(LocationHint.Origin origin)
origin
- tells who produces this hintpublic LocationHint(LocationHint.Hint hint)
hint
- tells where this hint likes to staypublic LocationHint(LocationHint.Origin origin, LocationHint.Hint hint)
origin
- tells who produces this hinthint
- tells where this hint likes to staypublic LocationHint(LocationHint.Origin origin, LocationHint.Hint hint, java.lang.Object clientObject)
origin
- tells who produces this hinthint
- tells where this hint likes to stayclientObject
- an object that can be freely chosen and used by client codepublic java.lang.Object getClientObject()
public void setClientObject(java.lang.Object clientObject)
clientObject
- the client-objectpublic LocationHint.Origin getOrigin()
public LocationHint.Hint getHint()
ActionOffer
how to interpret this property.