|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.station.flap.FlapDockStationFactory
public class FlapDockStationFactory
A DockFactory
which can handle FlapDockStation
s.
Field Summary | |
---|---|
static String |
ID
The default-id of this factory |
Constructor Summary | |
---|---|
FlapDockStationFactory()
|
Method Summary | |
---|---|
protected FlapDockStation |
createStation()
Creates an instance of a FlapDockStation . |
void |
estimateLocations(FlapDockStationLayout layout,
LocationEstimationMap children)
Tries to estimate the DockableProperty s of the children of the
station which is represented by layout . |
String |
getID()
Gets the unique name of this converter. |
FlapDockStationLayout |
getLayout(FlapDockStation station,
Map<Dockable,Integer> children)
Gets the layout of element . |
FlapDockStation |
layout(FlapDockStationLayout layout)
Creates a new DockElement and changes the layout of the new
element such that is matches layout . |
FlapDockStation |
layout(FlapDockStationLayout layout,
Map<Integer,Dockable> children)
Creates a new DockElement and changes the layout of the new
element such that is matches layout . |
FlapDockStationLayout |
read(DataInputStream in,
PlaceholderStrategy placeholders)
Reads a layout from a stream. |
FlapDockStationLayout |
read(XElement element,
PlaceholderStrategy placeholders)
Reads a layout from an xml-element. |
void |
setLayout(FlapDockStation station,
FlapDockStationLayout layout)
Reads the contents of layout and changes the layout of
element accordingly. |
void |
setLayout(FlapDockStation station,
FlapDockStationLayout layout,
Map<Integer,Dockable> children)
Reads the contents of layout and changes the layout of
element accordingly. |
void |
write(FlapDockStationLayout layout,
DataOutputStream out)
Writes the contents of layout into out . |
void |
write(FlapDockStationLayout layout,
XElement element)
Writes the contents of layout into element . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ID
Constructor Detail |
---|
public FlapDockStationFactory()
Method Detail |
---|
public String getID()
DockConverter
getID
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
public FlapDockStationLayout getLayout(FlapDockStation station, Map<Dockable,Integer> children)
DockConverter
element
. This method should create
a new instance of the layout object, that new object should not be
tied to element
in any way. A layout can be living for
a long period of time and might be used on another dockable
object.
getLayout
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
station
- the element for which a new layout should be createdchildren
- a map containing unique identifiers for the children
of the element. Children which are not in this map should not be
stored in the layout.children.size()
(excl.). The
same identifiers will be used as indices by a LocationEstimationMap
. See
also DockFactory.estimateLocations(Object, LocationEstimationMap)
.
public void setLayout(FlapDockStation station, FlapDockStationLayout layout)
DockConverter
layout
and changes the layout of
element
accordingly. This method should not add or remove
children to or from element
.
setLayout
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
station
- the element whose properties will be changedlayout
- the new set of propertiespublic void setLayout(FlapDockStation station, FlapDockStationLayout layout, Map<Integer,Dockable> children)
DockConverter
layout
and changes the layout of
element
accordingly. This method should remove all
children from element
and add new children.
setLayout
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
station
- the element whose content and children will be rearranged.layout
- the new layout of element
children
- some children, note that the map may not contain all elements
which were present when the layout was created.public void estimateLocations(FlapDockStationLayout layout, LocationEstimationMap children)
DockFactory
DockableProperty
s of the children of the
station which is represented by layout
.children.getChild( ... )
, this
factory may also access the leafs in the tree of Dockable
s through
children.getSubChild(...)
.DockableProperty
,
it is the callers responsibility to handle chains of stations.
estimateLocations
in interface DockFactory<FlapDockStation,FlapDockStationLayout>
layout
- this stationchildren
- the children of the station, this method should call
DockLayoutInfo.setLocation(DockableProperty)
or LocationEstimationMap.setLocation(int, DockableProperty)
and
LocationEstimationMap.setLocation(int, int, DockableProperty)
for as many children as possiblepublic FlapDockStation layout(FlapDockStationLayout layout, Map<Integer,Dockable> children)
DockFactory
DockElement
and changes the layout of the new
element such that is matches layout
.
layout
in interface DockFactory<FlapDockStation,FlapDockStationLayout>
layout
- the new layoutchildren
- some children, note that the map may not contain all elements
which were present when the layout was created.
null
if layout can't be usedpublic FlapDockStation layout(FlapDockStationLayout layout)
DockFactory
DockElement
and changes the layout of the new
element such that is matches layout
. This method should
not add any children to the element.
layout
in interface DockFactory<FlapDockStation,FlapDockStationLayout>
layout
- the new layout
null
if layout can't be usedpublic void write(FlapDockStationLayout layout, DataOutputStream out) throws IOException
DockConverter
layout
into out
.
write
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
layout
- the layout to storeout
- the stream to write into
IOException
- if an I/O-error occurspublic FlapDockStationLayout read(DataInputStream in, PlaceholderStrategy placeholders) throws IOException
DockConverter
read
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
in
- the stream to read fromplaceholders
- a strategy to detect invalid placeholders, can be null
.
Factories loading only Dockable
s but no DockStation
s can safely ignore this argument.
null
if the layout
should be discarded
IOException
- if an I/O-error occurspublic void write(FlapDockStationLayout layout, XElement element)
DockConverter
layout
into element
.
write
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
layout
- the layout to storeelement
- an xml-element into which this method should write, the
attributes of element
should not be changed.public FlapDockStationLayout read(XElement element, PlaceholderStrategy placeholders)
DockConverter
read
in interface DockConverter<FlapDockStation,FlapDockStationLayout>
element
- the element to read, should not be changed by this
method.placeholders
- a strategy to detect invalid placeholders, can be null
.
Factories loading only Dockable
s but no DockStation
s can safely ignore this argument.
null
if the layout
should be discardedprotected FlapDockStation createStation()
FlapDockStation
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |