bibliothek.gui.dock.common.intern
Class CommonMultipleDockableFactory

java.lang.Object
  bibliothek.gui.dock.common.intern.CommonMultipleDockableFactory

All Implemented Interfaces:

DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>, DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

public class CommonMultipleDockableFactory
extends Object
implements DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

A factory used to create CommonDockables. This factory is only used to create MultipleCDockables because SingleCDockables are stored by the client.

Author:

Benjamin Sigg

Constructor Summary

CommonMultipleDockableFactory(String id, MultipleCDockableFactory<?,?> delegate, CControlAccess access)
Creates a new factory.

CommonMultipleDockableFactory(String id, MultipleCDockableFactory<?,?> delegate, CControlAccess access, CPerspective perspective)
Creates a new factory.

Method Summary

void	estimateLocations(CommonMultipleDockableLayout 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( ...
MultipleCDockableFactory<?,?>	getFactory() Gets the delegate of this factory.
String	getID() Gets the unique name of this converter.
CommonMultipleDockableLayout	getLayout(CommonDockable element, Map<Dockable,Integer> children) Gets the layout of element.
CommonMultipleDockableLayout	getPerspectiveLayout(CommonElementPerspective element, Map<PerspectiveDockable,Integer> children) Gets the layout information that is associated with element.
CommonDockable	layout(CommonMultipleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders) Creates a new DockElement and changes the layout of the new element such that is matches layout.
CommonDockable	layout(CommonMultipleDockableLayout layout, PlaceholderStrategy placeholders) Creates a new DockElement and changes the layout of the new element such that is matches layout.
void	layoutPerspective(CommonElementPerspective perspective, CommonMultipleDockableLayout layout, Map<Integer,PerspectiveDockable> children) Updates the contents of perspective such that it reflects the contents of layout.
CommonElementPerspective	layoutPerspective(CommonMultipleDockableLayout layout, Map<Integer,PerspectiveDockable> children) Creates an element that can be used by a Perspective to create a layout without creating any DockElements.
CommonMultipleDockableLayout	read(DataInputStream in, PlaceholderStrategy placeholders) Reads a layout from a stream.
CommonMultipleDockableLayout	read(XElement element, PlaceholderStrategy placeholders) Reads a layout from an xml-element.
void	setLayout(CommonDockable element, CommonMultipleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders) Reads the contents of layout and changes the layout of element accordingly.
void	setLayout(CommonDockable element, CommonMultipleDockableLayout layout, PlaceholderStrategy placeholders) Reads the contents of layout and changes the layout of element accordingly.
void	write(CommonMultipleDockableLayout layout, DataOutputStream out) Writes the contents of layout into out.
void	write(CommonMultipleDockableLayout 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

Constructor Detail

CommonMultipleDockableFactory

public CommonMultipleDockableFactory(String id,
                                     MultipleCDockableFactory<?,?> delegate,
                                     CControlAccess access)

Creates a new factory.

Parameters:

id - the identifier of this factory

delegate - the factory that should be used to load the contents of the new CommonDockable

access - access to the internal affairs of a CControl

CommonMultipleDockableFactory

public CommonMultipleDockableFactory(String id,
                                     MultipleCDockableFactory<?,?> delegate,
                                     CControlAccess access,
                                     CPerspective perspective)

Creates a new factory.

Parameters:

id - the identifier of this factory

delegate - the factory that should be used to load the contents of the new CommonDockable

access - access to the internal affairs of a CControl

perspective - the CPerspective for which this factory is going to read and write elements

Method Detail

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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Returns:

the id

getFactory

public MultipleCDockableFactory<?,?> getFactory()

Gets the delegate of this factory.

Returns:

the delegate, not null

estimateLocations

public void estimateLocations(CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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

getLayout

public CommonMultipleDockableLayout getLayout(CommonDockable 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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.

getPerspectiveLayout

public CommonMultipleDockableLayout getPerspectiveLayout(CommonElementPerspective 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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

layoutPerspective

public void layoutPerspective(CommonElementPerspective perspective,
                              CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Parameters:

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

layoutPerspective

public CommonElementPerspective layoutPerspective(CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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()

layout

public CommonDockable layout(CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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 CommonDockable layout(CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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(CommonDockable element,
                      CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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(CommonDockable element,
                      CommonMultipleDockableLayout 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<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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.

read

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

Description copied from interface: DockConverter

Reads a layout from a stream.

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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

read

public CommonMultipleDockableLayout read(XElement element,
                                         PlaceholderStrategy placeholders)

Description copied from interface: DockConverter

Reads a layout from an xml-element.

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

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(CommonMultipleDockableLayout layout,
                  DataOutputStream out)
           throws IOException

Description copied from interface: DockConverter

Writes the contents of layout into out.

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Parameters:

layout - the layout to store

out - the stream to write into

Throws:

IOException - if an I/O-error occurs

write

public void write(CommonMultipleDockableLayout layout,
                  XElement element)

Description copied from interface: DockConverter

Writes the contents of layout into element.

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Parameters:

layout - the layout to store

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