bibliothek.gui.dock.station
Interface DisplayerFactory

All Known Implementing Classes:

BasicDisplayerFactory, BubbleDisplayerFactory, EclipseDisplayerFactory, FlatDisplayerFactory, ThemeDisplayerFactory

public interface DisplayerFactory

A factory that creates instances of DockableDisplayer.

Author:

Benjamin Sigg

Field Summary

static Path	DISPLAYER_EXTENSION unique identifier of an ExtensionName which allows extensions to insert high priority DisplayerFactorys
static String	DISPLAYER_EXTENSION_ID parameter for DISPLAYER_EXTENSION, this parameter depends on the DockStation which is using the displayers, each DockStation should have a constant defined with the name "DISPLAYER_ID" or a similar name (some stations may have more than one constant).

Method Summary

void

request(DisplayerRequest request) Creates a new DockableDisplayer, this method needs to call DisplayerRequest.answer(DockableDisplayer) once the new displayer is created. The new displayer will be shown on DisplayerRequest.getParent(), its content must be DisplayerRequest.getTarget() and DisplayerRequest.getTitle(). If this factory does not want to provide a DockableDisplayer for the given request, it can just return and not call DisplayerRequest.answer(DockableDisplayer).

Field Detail

DISPLAYER_EXTENSION

static final Path DISPLAYER_EXTENSION

unique identifier of an ExtensionName which allows extensions to insert high priority DisplayerFactorys

DISPLAYER_EXTENSION_ID

static final String DISPLAYER_EXTENSION_ID

parameter for DISPLAYER_EXTENSION, this parameter depends on the DockStation which is using the displayers, each DockStation should have a constant defined with the name "DISPLAYER_ID" or a similar name (some stations may have more than one constant).

See Also:

Constant Field Values

Method Detail

request

void request(DisplayerRequest request)

Creates a new DockableDisplayer, this method needs to call DisplayerRequest.answer(DockableDisplayer) once the new displayer is created.
The new displayer will be shown on DisplayerRequest.getParent(), its content must be DisplayerRequest.getTarget() and DisplayerRequest.getTitle().
If this factory does not want to provide a DockableDisplayer for the given request, it can just return and not call DisplayerRequest.answer(DockableDisplayer).

Parameters:

request - detailed information about who is going to show the displayer, and callback to set the new displayer