public interface DockableProperty
Dockable
on a DockStation
.
The properties can be nested, that describes the fact that a DockStation
can also be a Dockable
.DockableProperty
should not have any reference to its Dockable
or its
DockStation
.Modifier and Type | Method and Description |
---|---|
DockableProperty |
copy()
Gets a copy of this property, the
successor must be
copied as well. |
boolean |
equalsNoSuccessor(DockableProperty property)
|
String |
getFactoryID()
Gets the unique name of the
DockablePropertyFactory which
can create this type of DockableProperty. |
DockableProperty |
getSuccessor()
Gets the property which should be used for the child of this
dockable DockStation.
|
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 properties)
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 getSuccessor()
null
setSuccessor(DockableProperty)
void setSuccessor(DockableProperty properties)
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
.properties
- the location of a childDockableProperty copy()
successor
must be
copied as well.this
String getFactoryID()
DockablePropertyFactory
which
can create this type of DockableProperty.DockablePropertyFactory
boolean equalsNoSuccessor(DockableProperty property)
property
- the property to checktrue
if this
is the same as property
void store(DataOutputStream out) throws IOException
successor
(if there is one) must
not be saved.out
- the stream to write inIOException
- if anything unexpected happensvoid store(XElement element)
element
- the element into which to write, the attributes of
this element should not be changedvoid load(DataInputStream in) throws IOException
in
- the stream to readIOException
- if anything unexpected happensvoid load(XElement element)
DockableProperty
from an
xml element.element
- the element that was written earlier by this property