public class FlapDockProperty extends AbstractDockableProperty
FlapDockStation
to determine
the location of a Dockable
.Modifier and Type | Field and Description |
---|---|
static FlapDockProperty |
FIRST
The location of the first
Dockable . |
static FlapDockProperty |
LAST
The location of the last
Dockable . |
Constructor and Description |
---|
FlapDockProperty()
Constructs a FlapDockProperty
|
FlapDockProperty(int index)
Constructs a FlapDockProperty
|
FlapDockProperty(int index,
boolean holding,
int size)
Constructs a FlapDockProperty
|
FlapDockProperty(int index,
boolean holding,
int size,
Path placeholder)
Constructs a FlapDockProperty
|
Modifier and Type | Method and Description |
---|---|
FlapDockProperty |
copy()
Gets a copy of this property, the
successor must be
copied as well. |
boolean |
equals(Object obj) |
String |
getFactoryID()
Gets the unique name of the
DockablePropertyFactory which
can create this type of DockableProperty. |
int |
getIndex()
Gets the location of the
Dockable on its FlapDockStation . |
Path |
getPlaceholder()
Gets the name of this location.
|
int |
getSize()
Gets the size the window has in which the
Dockable will
be presented. |
int |
hashCode() |
boolean |
isHolding()
Tells whether an element was pinned down or not.
|
void |
load(DataInputStream in)
Reads the contents of this DockableProperty from a stream.
|
void |
load(XElement element)
Reads the contents of this
DockableProperty from an
xml element. |
void |
setHolding(boolean holding)
Whether the element should be pinned down or not.
|
void |
setIndex(int index)
Sets the location of the
Dockable on its FlapDockStation . |
void |
setPlaceholder(Path placeholder)
Sets the name of this location.
|
void |
setSize(int size)
Sets the size the window has in which the
Dockable will
be presented. |
void |
store(DataOutputStream out)
Stores the contents of this DockableProperty in a stream.
|
void |
store(XElement element)
Stores the contents of this property as xml element.
|
String |
toString() |
copy, equalsNoSuccessor, getSuccessor, setSuccessor
public static final FlapDockProperty FIRST
Dockable
.public static final FlapDockProperty LAST
Dockable
.public FlapDockProperty()
public FlapDockProperty(int index)
index
- the location of the Dockable
setIndex(int)
public FlapDockProperty(int index, boolean holding, int size)
index
- the location of the Dockable
holding
- whether the Dockable
is pinned down or notsize
- the size of the window, -1 if unknownsetIndex(int)
,
setHolding(boolean)
,
setSize(int)
public FlapDockProperty(int index, boolean holding, int size, Path placeholder)
index
- the location of the Dockable
holding
- whether the Dockable
is pinned down or notsize
- the size of the window, -1 if unknownplaceholder
- the name of this locationsetIndex(int)
,
setHolding(boolean)
,
setSize(int)
,
setPlaceholder(Path)
public FlapDockProperty copy()
DockableProperty
successor
must be
copied as well.this
public void setIndex(int index)
Dockable
on its FlapDockStation
.index
- the locationpublic int getIndex()
Dockable
on its FlapDockStation
.setIndex(int)
public void setHolding(boolean holding)
holding
- true
if it should be pinned, false
if notpublic boolean isHolding()
true
if pinned down, false
otherwisepublic void setSize(int size)
Dockable
will
be presented.size
- the size, -1 if unknownpublic int getSize()
Dockable
will
be presented.public void setPlaceholder(Path placeholder)
placeholder
- the placeholder, can be null
public Path getPlaceholder()
null
public String getFactoryID()
DockableProperty
DockablePropertyFactory
which
can create this type of DockableProperty.DockablePropertyFactory
public void store(DataOutputStream out) throws IOException
DockableProperty
successor
(if there is one) must
not be saved.out
- the stream to write inIOException
- if anything unexpected happenspublic void store(XElement element)
DockableProperty
element
- the element into which to write, the attributes of
this element should not be changedpublic void load(DataInputStream in) throws IOException
DockableProperty
in
- the stream to readIOException
- if anything unexpected happenspublic void load(XElement element)
DockableProperty
DockableProperty
from an
xml element.element
- the element that was written earlier by this propertypublic int hashCode()
hashCode
in class AbstractDockableProperty
public boolean equals(Object obj)
equals
in class AbstractDockableProperty