Package 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

Fields

Modifier and Type	Field	Description
static final String	FACTORY_ID	The unique identifier of this factory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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)
String	getID()
CommonDockStationLayout	getLayout(CommonDockStation<?,?> element, Map<Dockable,Integer> children)
CommonDockStationLayout	getPerspectiveLayout(CommonDockStationPerspective element, Map<PerspectiveDockable,Integer> children)
CommonDockStation<?,?>	layout(CommonDockStationLayout layout, PlaceholderStrategy placeholders)
CommonDockStation<?,?>	layout(CommonDockStationLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
CommonDockStationPerspective	layoutPerspective(CommonDockStationLayout layout, Map<Integer,PerspectiveDockable> children)
void	layoutPerspective(CommonDockStationPerspective element, CommonDockStationLayout layout, Map<Integer,PerspectiveDockable> children)
CommonDockStationLayout	read(XElement element, PlaceholderStrategy placeholders)
CommonDockStationLayout	read(DataInputStream in, PlaceholderStrategy placeholders)
protected void	registerStation(CStation<?> station, boolean root)	Register station at the CControl in whose realm this factory works.
void	setLayout(CommonDockStation<?,?> element, CommonDockStationLayout layout, PlaceholderStrategy placeholders)
void	setLayout(CommonDockStation<?,?> element, CommonDockStationLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
void	write(CommonDockStationLayout layout, XElement element)
void	write(CommonDockStationLayout layout, DataOutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FACTORY_ID

public static final String FACTORY_ID

The unique identifier of this factory

See Also:

• Constant Field Values

Constructor Details

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 Details

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

Specified by:

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

getLayout

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

Specified by:

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

layout

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

Specified by:

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

layout

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

Specified by:

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

setLayout

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

Specified by:

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

setLayout

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

Specified by:

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

estimateLocations

public void estimateLocations(CommonDockStationLayout layout,
 LocationEstimationMap children)

Specified by:

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

layoutPerspective

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

Specified by:

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

layoutPerspective

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

Specified by:

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

getPerspectiveLayout

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

Specified by:

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

write

public void write(CommonDockStationLayout layout,
 XElement element)

Specified by:

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

read

public CommonDockStationLayout read(XElement element,
 PlaceholderStrategy placeholders)

Specified by:

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

write

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

Specified by:

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

Throws:

IOException

read

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

Specified by:

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

Throws:

IOException