bibliothek.gui.dock.common.intern.station
Class CommonDockStationFactory

java.lang.Object
  bibliothek.gui.dock.common.intern.station.CommonDockStationFactory

All Implemented Interfaces:

DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>, DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

public class CommonDockStationFactory
extends Object
implements DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

A factory that is responsible for storing and loading the layout of the CommonDockStations. This factory actually forwards the work to a real DockFactory and only stores meta-data (like "was the CommonDockStation as SingleCDockable?").

Author:

Benjamin Sigg

Field Summary

static String

FACTORY_ID The unique identifier of this factory

Constructor Summary

CommonDockStationFactory(CControl control, FrontendPerspectiveCache cache, CommonSingleDockableFactory singleDockableFactory)
Creates a new factory

Method Summary

protected CommonDockStation<?,?>	createStation(String id) Creates a new CommonDockStation whose CStation is also a SingleCDockable with unique identifier id.
void	estimateLocations(CommonDockStationLayout layout, LocationEstimationMap children) Tries to estimate the DockablePropertys of the children of the station which is represented by layout. The children of this station are accessible through children.getChild( ...
String	getID() Gets the unique name of this converter.
CommonDockStationLayout	getLayout(CommonDockStation<?,?> element, Map<Dockable,Integer> children) Gets the layout of element.
CommonDockStationLayout	getPerspectiveLayout(CommonDockStationPerspective element, Map<PerspectiveDockable,Integer> children) Gets the layout information that is associated with element.
CommonDockStation<?,?>	layout(CommonDockStationLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders) Creates a new DockElement and changes the layout of the new element such that is matches layout.
CommonDockStation<?,?>	layout(CommonDockStationLayout layout, PlaceholderStrategy placeholders) Creates a new DockElement and changes the layout of the new element such that is matches layout.
CommonDockStationPerspective	layoutPerspective(CommonDockStationLayout layout, Map<Integer,PerspectiveDockable> children) Creates an element that can be used by a Perspective to create a layout without creating any DockElements.
void	layoutPerspective(CommonDockStationPerspective element, CommonDockStationLayout layout, Map<Integer,PerspectiveDockable> children) Updates the contents of perspective such that it reflects the contents of layout.
CommonDockStationLayout	read(DataInputStream in, PlaceholderStrategy placeholders) Reads a layout from a stream.
CommonDockStationLayout	read(XElement element, PlaceholderStrategy placeholders) Reads a layout from an xml-element.
protected void	registerStation(CStation<?> station, boolean root) Register station at the CControl in whose realm this factory works.
void	setLayout(CommonDockStation<?,?> element, CommonDockStationLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders) Reads the contents of layout and changes the layout of element accordingly.
void	setLayout(CommonDockStation<?,?> element, CommonDockStationLayout layout, PlaceholderStrategy placeholders) Reads the contents of layout and changes the layout of element accordingly.
void	write(CommonDockStationLayout layout, DataOutputStream out) Writes the contents of layout into out.
void	write(CommonDockStationLayout 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

FACTORY_ID

public static final String FACTORY_ID

The unique identifier of this factory

See Also:

Constant Field Values

Constructor Detail

CommonDockStationFactory

public CommonDockStationFactory(CControl control,
                                FrontendPerspectiveCache cache,
                                CommonSingleDockableFactory singleDockableFactory)

Creates a new factory

Parameters:

control - the CControl in whose realm this factory works, not null

cache - used to create missing PerspectiveElements, can be null

singleDockableFactory - the factory used to create new CommonDockStations that are also SingleCDockables, not null

Method Detail

createStation

protected CommonDockStation<?,?> createStation(String id)

Creates a new CommonDockStation whose CStation is also a SingleCDockable with unique identifier id.

Parameters:

id - the unique identifier of a SingleCDockable

Returns:

the new station or null if id is unknown

registerStation

protected void registerStation(CStation<?> station,
                               boolean root)

Register station at the CControl in whose realm this factory works.

Parameters:

station - the station to register

root - whether to set the root flag or not

getID

public String getID()

Description copied from interface: DockConverter

Gets the unique name of this converter. Please note that unique identifiers starting with "dock." should not be used by clients.

Specified by:

getID in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Returns:

the id

getLayout

public CommonDockStationLayout getLayout(CommonDockStation<?,?> element,
                                         Map<Dockable,Integer> children)

Description copied from interface: DockConverter

Gets the layout of 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.

Specified by:

getLayout in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

element - the element for which a new layout should be created

children - 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.
The identifiers are in the range from 0 (incl.) to children.size() (excl.). The same identifiers will be used as indices by a LocationEstimationMap. See also DockFactory.estimateLocations(Object, LocationEstimationMap).

Returns:

the newly created, independent layout object.

layout

public CommonDockStation<?,?> layout(CommonDockStationLayout layout,
                                     Map<Integer,Dockable> children,
                                     PlaceholderStrategy placeholders)

Description copied from interface: DockFactory

Creates a new DockElement and changes the layout of the new element such that is matches layout.

Specified by:

layout in interface DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - the new layout

children - some children, note that the map may not contain all elements which were present when the layout was created.

placeholders - a strategy to detect invalid placeholders, can be null. Factories loading only Dockables but no DockStations can safely ignore this argument.

Returns:

a new element or null if layout can't be used

layout

public CommonDockStation<?,?> layout(CommonDockStationLayout layout,
                                     PlaceholderStrategy placeholders)

Description copied from interface: DockFactory

Creates a new DockElement and changes the layout of the new element such that is matches layout. This method should not add any children to the element.

Specified by:

layout in interface DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - the new layout

placeholders - a strategy to detect invalid placeholders, can be null. Factories loading only Dockables but no DockStations can safely ignore this argument.

Returns:

a new element or null if layout can't be used

setLayout

public void setLayout(CommonDockStation<?,?> element,
                      CommonDockStationLayout layout,
                      Map<Integer,Dockable> children,
                      PlaceholderStrategy placeholders)

Description copied from interface: DockConverter

Reads the contents of layout and changes the layout of element accordingly. This method should remove all children from element and add new children.

Specified by:

setLayout in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

element - 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.

placeholders - a strategy to detect invalid placeholders, can be null. Factories loading only Dockables but no DockStations can safely ignore this argument.

setLayout

public void setLayout(CommonDockStation<?,?> element,
                      CommonDockStationLayout layout,
                      PlaceholderStrategy placeholders)

Description copied from interface: DockConverter

Reads the contents of layout and changes the layout of element accordingly. This method should not add or remove children to or from element.

Specified by:

setLayout in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

element - the element whose properties will be changed

layout - the new set of properties

placeholders - a strategy to detect invalid placeholders, can be null. Factories loading only Dockables but no DockStations can safely ignore this argument.

estimateLocations

public void estimateLocations(CommonDockStationLayout layout,
                              LocationEstimationMap children)

Description copied from interface: DockFactory

Tries to estimate the DockablePropertys of the children of the station which is represented by layout.
The children of this station are accessible through children.getChild( ... ), this factory may also access the leafs in the tree of Dockables through children.getSubChild(...).
Note: this method must not set the successor of any DockableProperty, it is the callers responsibility to handle chains of stations.

Specified by:

estimateLocations in interface DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - this station

children - 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 possible

layoutPerspective

public CommonDockStationPerspective layoutPerspective(CommonDockStationLayout layout,
                                                      Map<Integer,PerspectiveDockable> children)

Description copied from interface: DockFactory

Creates an element that can be used by a Perspective to create a layout without creating any DockElements. This method may return null only if the client is guaranteed not to use a Perspective.

Specified by:

layoutPerspective in interface DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - the new layout

children - some children, note that the map may not contain all elements which were present when the layout was created. Is null if the children of this station are going to be ignored.

Returns:

the new element, can be null, the return value of PerspectiveElement.getFactoryID() should be equal to DockConverter.getID()

layoutPerspective

public void layoutPerspective(CommonDockStationPerspective element,
                              CommonDockStationLayout layout,
                              Map<Integer,PerspectiveDockable> children)

Description copied from interface: DockFactory

Updates the contents of perspective such that it reflects the contents of layout.

Specified by:

layoutPerspective in interface DockFactory<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

element - the perspective that is to be updated

layout - the layout to apply

children - the new children of perspective, is null if the children of this station are going to be ignored.

getPerspectiveLayout

public CommonDockStationLayout getPerspectiveLayout(CommonDockStationPerspective element,
                                                    Map<PerspectiveDockable,Integer> children)

Description copied from interface: DockConverter

Gets the layout information that is associated with element. The layout information can be any Object. The only restriction of the object is, that the associated DockFactory understands how to read that object.

Specified by:

getPerspectiveLayout in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

element - the element whose layout information is asked.

children - a map providing identifiers for the children of this element. The identifiers are in the range from 0 (incl.) to children.size() (excl.), the exact same identifiers would be given to DockConverter.getLayout(bibliothek.gui.dock.DockElement, Map). Is null if the children of this station should be ignored.

Returns:

the layout information, may be null if this converter does not support perspectives

write

public void write(CommonDockStationLayout layout,
                  XElement element)

Description copied from interface: DockConverter

Writes the contents of layout into element.

Specified by:

write in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - the layout to store

element - an xml-element into which this method should write, the attributes of element should not be changed.

read

public CommonDockStationLayout read(XElement element,
                                    PlaceholderStrategy placeholders)

Description copied from interface: DockConverter

Reads a layout from an xml-element.

Specified by:

read in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

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 Dockables but no DockStations can safely ignore this argument.

Returns:

the new layout, can be null if the layout should be discarded

write

public void write(CommonDockStationLayout layout,
                  DataOutputStream out)
           throws IOException

Description copied from interface: DockConverter

Writes the contents of layout into out.

Specified by:

write in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

layout - the layout to store

out - the stream to write into

Throws:

IOException - if an I/O-error occurs

read

public CommonDockStationLayout read(DataInputStream in,
                                    PlaceholderStrategy placeholders)
                             throws IOException

Description copied from interface: DockConverter

Reads a layout from a stream.

Specified by:

read in interface DockConverter<CommonDockStation<?,?>,CommonDockStationPerspective,CommonDockStationLayout>

Parameters:

in - the stream to read from

placeholders - a strategy to detect invalid placeholders, can be null. Factories loading only Dockables but no DockStations can safely ignore this argument.

Returns:

the new layout, can be null if the layout should be discarded

Throws:

IOException - if an I/O-error occurs