bibliothek.gui.dock.common.intern

Class CommonSingleDockableFactory

java.lang.Object

bibliothek.gui.dock.common.intern.CommonSingleDockableFactory

All Implemented Interfaces:

DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>, DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

public class CommonSingleDockableFactory
extends Object
implements DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

This factory is used to create new SingleCDockables using various SingleCDockableFactorys. This factory is accessed when a single dockable is missing in the cache of its owning CControl.

Author:

Benjamin Sigg

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKUP_FACTORY_ID

Constructor Summary

Constructors

Constructor and Description
CommonSingleDockableFactory(CControl control) Creates a new factory.
CommonSingleDockableFactory(CControl control, CPerspective perspective) Creates a new factory.

Method Summary

Modifier and Type	Method and Description
void	add(Filter<String> ids, SingleCDockableFactory factory) Registers a new factory that will load SingleCDockable with unique identifiers that are included by ids.
void	add(String id, SingleCDockableFactory factory) Registers a new factory that will load SingleCDockables with the unique id id.
void	estimateLocations(CommonSingleDockableLayout layout, LocationEstimationMap children)
SingleCDockableFactory	getFactory(String id) Searches the factory which handles id.
Set<String>	getFactoryIds() Gets the set of keys for all factories known to this.
String	getID()
CommonSingleDockableLayout	getLayout(CommonDockable element, Map<Dockable,Integer> children)
CommonSingleDockableLayout	getPerspectiveLayout(CommonElementPerspective element, Map<PerspectiveDockable,Integer> children)
CommonDockable	layout(CommonSingleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
CommonDockable	layout(CommonSingleDockableLayout layout, PlaceholderStrategy placeholders)
void	layoutPerspective(CommonElementPerspective perspective, CommonSingleDockableLayout layout, Map<Integer,PerspectiveDockable> children)
CommonElementPerspective	layoutPerspective(CommonSingleDockableLayout layout, Map<Integer,PerspectiveDockable> children)
String[]	listFactories() Gets a list of keys for all factories known to this.
CommonSingleDockableLayout	read(DataInputStream in, PlaceholderStrategy placeholders)
CommonSingleDockableLayout	read(XElement element, PlaceholderStrategy placeholders)
void	remove(SingleCDockableFactory factory) Removes any occurrence of factory.
void	remove(String id) Removes a factory from this.
void	setLayout(CommonDockable element, CommonSingleDockableLayout layout, Map<Integer,Dockable> children, PlaceholderStrategy placeholders)
void	setLayout(CommonDockable element, CommonSingleDockableLayout layout, PlaceholderStrategy placeholders)
void	write(CommonSingleDockableLayout layout, DataOutputStream out)
void	write(CommonSingleDockableLayout layout, XElement element)

Methods inherited from class java.lang.Object

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

Field Detail

BACKUP_FACTORY_ID

public static final String BACKUP_FACTORY_ID

See Also:

Constant Field Values

Constructor Detail

CommonSingleDockableFactory

public CommonSingleDockableFactory(CControl control)

Creates a new factory.

Parameters:

control - the owner of the factory, the factory will add SingleCDockable to this control

CommonSingleDockableFactory

public CommonSingleDockableFactory(CControl control,
                                   CPerspective perspective)

Creates a new factory.

Parameters:

control - the owner of the factory, the factory will add SingleCDockable to this control

perspective - the perspective which is used to load perspective related content

Method Detail

add

public void add(String id,
                SingleCDockableFactory factory)

Registers a new factory that will load SingleCDockables with the unique id id.

Parameters:

id - the unique id of the dockables which factory will create

factory - the new factory

add

public void add(Filter<String> ids,
                SingleCDockableFactory factory)

Registers a new factory that will load SingleCDockable with unique identifiers that are included by ids.

Parameters:

ids - the identifiers that are included

factory - the new factory

remove

public void remove(String id)

Removes a factory from this.

Parameters:

id - the name of the factory to remove

remove

public void remove(SingleCDockableFactory factory)

Removes any occurrence of factory.

Parameters:

factory - the factory to remove

getFactory

public SingleCDockableFactory getFactory(String id)

Searches the factory which handles id.

Parameters:

id - the name of a factory

Returns:

the factory or null

getID

public String getID()

Specified by:

getID in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

listFactories

public String[] listFactories()

Gets a list of keys for all factories known to this.

Returns:

the list of keys

getFactoryIds

public Set<String> getFactoryIds()

Gets the set of keys for all factories known to this.

Returns:

the set of keys

estimateLocations

public void estimateLocations(CommonSingleDockableLayout layout,
                              LocationEstimationMap children)

Specified by:

estimateLocations in interface DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

getLayout

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

Specified by:

getLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

layout

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

Specified by:

layout in interface DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

layout

public CommonDockable layout(CommonSingleDockableLayout layout,
                             PlaceholderStrategy placeholders)

Specified by:

layout in interface DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

layoutPerspective

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

Specified by:

layoutPerspective in interface DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

layoutPerspective

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

Specified by:

layoutPerspective in interface DockFactory<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

getPerspectiveLayout

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

Specified by:

getPerspectiveLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

read

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

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

Throws:

IOException

read

public CommonSingleDockableLayout read(XElement element,
                                       PlaceholderStrategy placeholders)

Specified by:

read in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

setLayout

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

Specified by:

setLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

setLayout

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

Specified by:

setLayout in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

write

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

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>

Throws:

IOException

write

public void write(CommonSingleDockableLayout layout,
                  XElement element)

Specified by:

write in interface DockConverter<CommonDockable,CommonElementPerspective,CommonSingleDockableLayout>