public interface DockTheme
DockStation
looks like, which DockTitle
are selected, and other behavior.
A theme needs only to support one DockController
at a time.ThemeManager
and
the DockProperties
should be used. To request a value from the ThemeManager
the method
add
must
be used to install an observer (of type UIValue
). The PropertyKey
s specified in this interface may
be used directly, but clients should bear in mind that the ThemeManager
can override resources that are
stored in the DockProperties
.Modifier and Type | Field and Description |
---|---|
static PropertyKey<BackgroundPaint> |
BACKGROUND_PAINT
A unique identifier for the
DockProperties to access the current BackgroundPaint . |
static PropertyKey<BorderModifier> |
BORDER_MODIFIER
A unique identifier for the
DockProperties to access the current BorderModifier . |
static PropertyKey<Combiner> |
COMBINER
A unique identifier for the
DockProperties to access the current Combiner . |
static PropertyKey<DisplayerFactory> |
DISPLAYER_FACTORY
A unique identifier for the
DockProperties to access the current DisplayerFactory . |
static PropertyKey<DockableMovingImageFactory> |
DOCKABLE_MOVING_IMAGE_FACTORY
Identifier for the
DockableMovingImageFactory that is used to show an image during
drag and drop operations. |
static PropertyKey<DockableSelection> |
DOCKABLE_SELECTION
Identifier for the
DockableSelection , a panel that is shown to select a Dockable
using only the keyboard. |
static PropertyKey<SpanFactory> |
SPAN_FACTORY
|
static PropertyKey<StationPaint> |
STATION_PAINT
A unique identifier for the
DockProperties to access the current StationPaint . |
Modifier and Type | Method and Description |
---|---|
Combiner |
getCombiner(DockStation station)
Gets the Combiner for
station .This method should not be used directly, instead an UIValue of type StationCombinerValue should
be installed at the local ThemeManager to retrieve the value. |
DisplayerFactory |
getDisplayFactory(DockStation station)
Gets a displayer factory for
station .This method should not be used directly, instead an UIValue of type DefaultDisplayerFactoryValue should
be installed at the local ThemeManager to retrieve the value. |
DockableSelection |
getDockableSelection(DockController controller)
Gets a selector for
Dockable s. |
DockableMovingImageFactory |
getMovingImageFactory(DockController controller)
Gets a factory for images which are moved around by the user.
This method should not be invoked directly, instead the property key DOCKABLE_MOVING_IMAGE_FACTORY
should be used. |
StationPaint |
getPaint(DockStation station)
Gets the paint which is used to draw things onto
station .This method should not be used directly, instead an UIValue of type DefaultStationPaintValue should
be installed at the local ThemeManager to retrieve the value. |
DockTitleFactory |
getTitleFactory(DockController controller)
Gets the default
DockTitleFactory which is used if no other factory is set.The result of this method is installed in the DockTitleManager using
the key DockTitleManager.THEME_FACTORY_ID and priority Priority.THEME . |
void |
install(DockController controller,
DockThemeExtension[] extensions)
Install this theme at
controller . |
void |
uninstall(DockController controller)
Uninstalls this theme from
controller . |
static final PropertyKey<BackgroundPaint> BACKGROUND_PAINT
DockProperties
to access the current BackgroundPaint
.static final PropertyKey<BorderModifier> BORDER_MODIFIER
DockProperties
to access the current BorderModifier
.static final PropertyKey<SpanFactory> SPAN_FACTORY
static final PropertyKey<Combiner> COMBINER
DockProperties
to access the current Combiner
. The default
value will be derived from the current DockTheme
.static final PropertyKey<StationPaint> STATION_PAINT
DockProperties
to access the current StationPaint
. The default
value will be derived from the current DockTheme
.static final PropertyKey<DisplayerFactory> DISPLAYER_FACTORY
DockProperties
to access the current DisplayerFactory
. The default
value will be derived from the current DockTheme
.static final PropertyKey<DockableMovingImageFactory> DOCKABLE_MOVING_IMAGE_FACTORY
DockableMovingImageFactory
that is used to show an image during
drag and drop operations.static final PropertyKey<DockableSelection> DOCKABLE_SELECTION
DockableSelection
, a panel that is shown to select a Dockable
using only the keyboard.void install(DockController controller, DockThemeExtension[] extensions)
controller
. The theme
may change any properties it likes.controller
- the controllerextensions
- a set of extensions specifically for this themevoid uninstall(DockController controller)
controller
. The theme
has to remove all listeners it added.controller
- the controller@FrameworkOnly Combiner getCombiner(DockStation station)
station
.UIValue
of type StationCombinerValue
should
be installed at the local ThemeManager
to retrieve the value.station
- the station whose combiner is searchedstation
@FrameworkOnly StationPaint getPaint(DockStation station)
station
.UIValue
of type DefaultStationPaintValue
should
be installed at the local ThemeManager
to retrieve the value.station
- the station to paint onstation
@FrameworkOnly DisplayerFactory getDisplayFactory(DockStation station)
station
.UIValue
of type DefaultDisplayerFactoryValue
should
be installed at the local ThemeManager
to retrieve the value.station
- the station on which the created DockableDisplayer
is shownDockTitleFactory getTitleFactory(DockController controller)
DockTitleFactory
which is used if no other factory is set.DockTitleManager
using
the key DockTitleManager.THEME_FACTORY_ID
and priority Priority.THEME
. A
theme may use the manager to change the factory at any time.controller
- the controller using this theme@FrameworkOnly DockableMovingImageFactory getMovingImageFactory(DockController controller)
DOCKABLE_MOVING_IMAGE_FACTORY
should be used.controller
- the controller for which the factory is needed@FrameworkOnly DockableSelection getDockableSelection(DockController controller)
Dockable
s. This method should not be invoked directly, instead
the property key DOCKABLE_SELECTION
should be used.controller
- the controller for which the selector will be used