public class SplitDockPlaceholderProperty extends AbstractDockableProperty
SplitDockStation
.Constructor and Description |
---|
SplitDockPlaceholderProperty()
Creates a new empty property
|
SplitDockPlaceholderProperty(Path placeholder)
Creates a new property.
|
SplitDockPlaceholderProperty(Path placeholder,
SplitDockPathProperty backup)
Creates a new property.
|
SplitDockPlaceholderProperty(Path placeholder,
SplitDockProperty backup)
Creates a new property.
|
Modifier and Type | Method and Description |
---|---|
SplitDockPlaceholderProperty |
copy()
Gets a copy of this property, the
successor must be
copied as well. |
DockableProperty |
getBackup()
Gets the backup location that was set when this
SplitDockPlaceholderProperty
was created. |
String |
getFactoryID()
Gets the unique name of the
DockablePropertyFactory which
can create this type of DockableProperty. |
Path |
getPlaceholder()
Gets the placeholder this property references to.
|
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 |
setSuccessor(DockableProperty successor)
Sets the property which will be used if this property was used and
there is not yet a leaf in the tree of DockStations and Dockables reached.
For example: there is a DockStation root , a
dockable DockStation node which is a child of root
and a Dockable leaf which is a child of node .A DockableProperty called one would describe the relationship
between root and node . |
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.
|
DockableProperty |
toLocation(SplitNode target)
Gets some
DockableProperty that works as backup property
if the referenced placeholder is not found. |
SplitDockProperty |
toSplitLocation(SplitNode target)
Gets a
SplitDockProperty that works as backup property
if the referenced placeholder is not found. |
String |
toString() |
copy, equals, equalsNoSuccessor, getSuccessor, hashCode
public SplitDockPlaceholderProperty()
public SplitDockPlaceholderProperty(Path placeholder)
placeholder
- the referenced placeholderpublic SplitDockPlaceholderProperty(Path placeholder, SplitDockProperty backup)
placeholder
- the referenced placeholderbackup
- backup location to be used if placeholder
is not foundpublic SplitDockPlaceholderProperty(Path placeholder, SplitDockPathProperty backup)
placeholder
- the referenced placeholderbackup
- backup location to be used if placeholder
is not foundpublic Path getPlaceholder()
null
public DockableProperty toLocation(SplitNode target)
DockableProperty
that works as backup property
if the referenced placeholder is not found.target
- the node that asks for this locationnull
public SplitDockProperty toSplitLocation(SplitNode target)
SplitDockProperty
that works as backup property
if the referenced placeholder is not found.target
- the node that asks for this locationnull
public void setSuccessor(DockableProperty successor)
DockableProperty
root
, a
dockable DockStation node
which is a child of root
and a Dockable leaf
which is a child of node
.one
would describe the relationship
between root
and node
. Another DockableProperty
called two
would describe the relationship between
node
and leaf
. In this case, the successor
of one
would be two
.setSuccessor
in interface DockableProperty
setSuccessor
in class AbstractDockableProperty
successor
- the location of a childpublic DockableProperty getBackup()
SplitDockPlaceholderProperty
was created.null
public SplitDockPlaceholderProperty copy()
DockableProperty
successor
must be
copied as well.this
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 load(DataInputStream in) throws IOException
DockableProperty
in
- the stream to readIOException
- 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(XElement element)
DockableProperty
DockableProperty
from an
xml element.element
- the element that was written earlier by this property