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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
void	estimateLocations(CommonMultipleDockableLayout layout, LocationEstimationMap children)
MultipleCDockableFactory<?,?>	getFactory() Gets the delegate of this factory.
String	getID()
CommonMultipleDockableLayout	getLayout(CommonDockable element, Map<Dockable,Integer> children)
CommonMultipleDockableLayout	getPerspectiveLayout(CommonElementPerspective element, Map<PerspectiveDockable,Integer> children)
CommonDockable	layout(CommonMultipleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
CommonDockable	layout(CommonMultipleDockableLayout layout, PlaceholderStrategy placeholders)
void	layoutPerspective(CommonElementPerspective perspective, CommonMultipleDockableLayout layout, Map<Integer,PerspectiveDockable> children)
CommonElementPerspective	layoutPerspective(CommonMultipleDockableLayout layout, Map<Integer,PerspectiveDockable> children)
CommonMultipleDockableLayout	read(DataInputStream in, PlaceholderStrategy placeholders)
CommonMultipleDockableLayout	read(XElement element, PlaceholderStrategy placeholders)
void	setLayout(CommonDockable element, CommonMultipleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
void	setLayout(CommonDockable element, CommonMultipleDockableLayout layout, PlaceholderStrategy placeholders)
void	write(CommonMultipleDockableLayout layout, DataOutputStream out)
void	write(CommonMultipleDockableLayout layout, XElement 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()

Specified by:

getID in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

getFactory

public MultipleCDockableFactory<?,?> getFactory()

Gets the delegate of this factory.

Returns:

the delegate, not null

estimateLocations

public void estimateLocations(CommonMultipleDockableLayout layout,
                              LocationEstimationMap children)

Specified by:

estimateLocations in interface DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

getLayout

public CommonMultipleDockableLayout getLayout(CommonDockable element,
                                              Map<Dockable,Integer> children)

Specified by:

getLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

getPerspectiveLayout

public CommonMultipleDockableLayout getPerspectiveLayout(CommonElementPerspective element,
                                                         Map<PerspectiveDockable,Integer> children)

Specified by:

getPerspectiveLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

layoutPerspective

public void layoutPerspective(CommonElementPerspective perspective,
                              CommonMultipleDockableLayout layout,
                              Map<Integer,PerspectiveDockable> children)

Specified by:

layoutPerspective in interface DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

layoutPerspective

public CommonElementPerspective layoutPerspective(CommonMultipleDockableLayout layout,
                                                  Map<Integer,PerspectiveDockable> children)

Specified by:

layoutPerspective in interface DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

layout

public CommonDockable layout(CommonMultipleDockableLayout layout,
                             Map<Integer,Dockable> children,
                             PlaceholderStrategy placeholders)

Specified by:

layout in interface DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

layout

public CommonDockable layout(CommonMultipleDockableLayout layout,
                             PlaceholderStrategy placeholders)

Specified by:

layout in interface DockFactory<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

setLayout

public void setLayout(CommonDockable element,
                      CommonMultipleDockableLayout layout,
                      Map<Integer,Dockable> children,
                      PlaceholderStrategy placeholders)

Specified by:

setLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

setLayout

public void setLayout(CommonDockable element,
                      CommonMultipleDockableLayout layout,
                      PlaceholderStrategy placeholders)

Specified by:

setLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

read

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

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Throws:

IOException

read

public CommonMultipleDockableLayout read(XElement element,
                                         PlaceholderStrategy placeholders)

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

write

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

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>

Throws:

IOException

write

public void write(CommonMultipleDockableLayout layout,
                  XElement element)

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonMultipleDockableLayout>