public class CommonDockStationLayout
extends java.lang.Object
CommonDockStation
, used by the CommonDockStationFactory
to store and load the layout.Constructor and Description |
---|
CommonDockStationLayout(java.lang.String id,
boolean root,
java.lang.String factoryId,
byte[] layout)
Creates a new layout.
|
CommonDockStationLayout(java.lang.String id,
boolean root,
java.lang.String factoryId,
DockLayout<?> layout)
Creates a new layout.
|
CommonDockStationLayout(java.lang.String id,
boolean root,
java.lang.String factoryId,
XElement layout)
Creates a new layout.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getFactoryId()
Gets the unique id of the
DockFactory that is used to read and store the actual layout. |
java.lang.String |
getId()
Gets the unique id of the
CommonDockStation which is described by this layout. |
DockLayout<?> |
getLayout()
Gets the layout information that was produced the
DockFactory with id getFactoryId() . |
byte[] |
getLayoutBytes()
Gets the layout information as byte array, assuming that the layout information is stored
as byte array.
|
XElement |
getLayoutXML()
Gets the layout information as xml element, assuming that the layout information is stored
in xml.
|
boolean |
isRoot()
|
void |
updateLayout(DockFactory<?,?,java.lang.Object> factory,
PlaceholderStrategy placeholders)
Updates the contents of the internal
DockLayoutInfo using factory to read
a byte array or an XElement . |
public CommonDockStationLayout(java.lang.String id, boolean root, java.lang.String factoryId, DockLayout<?> layout)
id
- the unique identifier of the described CommonDockStation
, might be null
root
- whether the CStation
is a root stationfactoryId
- the unique identifier of the DockFactory
that is used to read or write the actual
layoutlayout
- the layout that was loaded by the factory factoryId
public CommonDockStationLayout(java.lang.String id, boolean root, java.lang.String factoryId, byte[] layout)
id
- the unique identifier of the described CommonDockStation
, might be null
root
- whether the CStation
is a root stationfactoryId
- the unique identifier of the DockFactory
that is used to read or write the actual
layoutlayout
- the layout that might be loaded by the factory factoryId
public CommonDockStationLayout(java.lang.String id, boolean root, java.lang.String factoryId, XElement layout)
id
- the unique identifier of the described CommonDockStation
, might be null
root
- whether the CStation
is a root stationfactoryId
- the unique identifier of the DockFactory
that is used to read or write the actual
layoutlayout
- the layout that might be loaded by the factory factoryId
public void updateLayout(DockFactory<?,?,java.lang.Object> factory, PlaceholderStrategy placeholders)
DockLayoutInfo
using factory
to read
a byte array or an XElement
.factory
- the factory used to read the layoutplaceholders
- the placeholders that may be usedpublic java.lang.String getId()
CommonDockStation
which is described by this layout.null
public boolean isRoot()
public java.lang.String getFactoryId()
DockFactory
that is used to read and store the actual layout.null
public byte[] getLayoutBytes()
null
if not stored in byte array formatpublic XElement getLayoutXML()
null
if not stored in xml formatpublic DockLayout<?> getLayout()
DockFactory
with id getFactoryId()
.null
if not present in object format