|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.themes.BasicTheme
public class BasicTheme
A theme
that does not install anything and uses the
default-implementations off all factories. It is possible to replace
any of the factories.
Field Summary | |
---|---|
static PropertyKey<ColorScheme> |
BASIC_COLOR_SCHEME
the key to set the ColorScheme of this theme |
Fields inherited from interface bibliothek.gui.DockTheme |
---|
BACKGROUND_PAINT, BORDER_MODIFIER, COMBINER, DISPLAYER_FACTORY, DOCKABLE_MOVING_IMAGE_FACTORY, DOCKABLE_SELECTION, SPAN_FACTORY, STATION_PAINT |
Constructor Summary | |
---|---|
BasicTheme()
Creates a new BasicTheme . |
Method Summary | |
---|---|
ColorScheme |
getColorScheme()
Gets the currently used color scheme |
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. |
DockController |
getController()
Gets the currently installed controller |
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 DockTheme.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. |
TabPlacement |
getTabPlacement()
Gets the side at which tabs are displayed. |
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 . |
protected void |
install(DockController controller)
Installs the basic items of this theme, ignoring any DockThemeExtension . |
void |
install(DockController controller,
DockThemeExtension[] extensions)
Install this theme at controller . |
void |
setColorScheme(ColorScheme colorScheme)
Sets the currently used set of colors. |
protected void |
setColorSchemeKey(PropertyKey<ColorScheme> key)
Sets the key that will be used to read the ColorScheme of this
theme from the DockProperties . |
void |
setCombiner(Combiner combiner)
Sets the Combiner of this theme. |
void |
setCombiner(Combiner combiner,
Priority priority)
Sets the Combiner of this theme. |
void |
setDisplayerFactory(DisplayerFactory factory)
Sets the DisplayerFactory of this theme. |
void |
setDisplayerFactory(DisplayerFactory factory,
Priority priority)
Sets the DisplayerFactory of this theme. |
void |
setDockableSelection(DockableSelection selection)
Sets how the user can select the focused Dockable . |
void |
setDockableSelection(DockableSelection selection,
Priority priority)
Sets how the user can select the focused Dockable . |
void |
setMovingImageFactory(DockableMovingImageFactory movingImage)
Sets the movingImage-property. |
void |
setMovingImageFactory(DockableMovingImageFactory movingImage,
Priority priority)
Sets the movingImage-property. |
void |
setPaint(StationPaint paint)
Sets the StationPaint of this theme. |
void |
setPaint(StationPaint paint,
Priority priority)
Sets the StationPaint of this theme. |
void |
setSpanFactory(SpanFactory factory)
Sets the factory which will be used to create new Span s. |
void |
setSpanFactory(SpanFactory factory,
Priority priority)
Sets the factory which will be used to create new Span s. |
void |
setStackDockComponentFactory(StackDockComponentFactory stackDockComponentFactory)
Sets the factory which will be used to create components for StackDockStation . |
void |
setStackDockComponentFactory(StackDockComponentFactory stackDockComponentFactory,
Priority priority)
Sets the factory which will be used to create components for StackDockStation . |
void |
setTabPlacement(TabPlacement tabPlacement)
Sets the side at which tabs are to be displayed. |
void |
setTabPlacement(TabPlacement tabPlacement,
Priority priority)
Sets the side at which tabs are to be displayed. |
void |
setTitleFactory(DockTitleFactory titleFactory)
Sets the DockTitleFactory of this station. |
void |
setTitleFactory(DockTitleFactory titleFactory,
Priority priority)
Sets the DockTitleFactory of this station. |
void |
uninstall(DockController controller)
Uninstalls this theme from controller . |
protected void |
updateColors()
Called when the the colors of the ColorManager have to be updated. |
void |
updateUI()
Called when the LookAndFeel changed, should update colors, fonts, ... |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final PropertyKey<ColorScheme> BASIC_COLOR_SCHEME
ColorScheme
of this theme
Constructor Detail |
---|
public BasicTheme()
BasicTheme
.
Method Detail |
---|
public void install(DockController controller, DockThemeExtension[] extensions)
DockTheme
controller
. The theme
may change any properties it likes.
install
in interface DockTheme
controller
- the controllerextensions
- a set of extensions specifically for this themeprotected void install(DockController controller)
DockThemeExtension
.
controller
- the new owner of this themepublic void uninstall(DockController controller)
DockTheme
controller
. The theme
has to remove all listeners it added.
uninstall
in interface DockTheme
controller
- the controllerpublic void updateUI()
LookAndFeel
changed, should update colors, fonts, ...
protected void updateColors()
ColorManager
have to be updated. This method reads
the current ColorScheme
and installs it using
UIProperties.setScheme(Priority, bibliothek.gui.dock.util.UIScheme)
with a priority
of Priority.CLIENT
.
public DockController getController()
protected void setColorSchemeKey(PropertyKey<ColorScheme> key)
ColorScheme
of this
theme from the DockProperties
.
key
- the new key, not null
setColorScheme(ColorScheme)
public void setColorScheme(ColorScheme colorScheme)
DockController
s
will change immediately.
colorScheme
- the new scheme, null
will
activate the default color scheme.public ColorScheme getColorScheme()
public void setStackDockComponentFactory(StackDockComponentFactory stackDockComponentFactory)
StackDockStation
. Note that this property has to be set
before the theme is installed. Otherwise it will take no effect.
stackDockComponentFactory
- the factory or null
public void setStackDockComponentFactory(StackDockComponentFactory stackDockComponentFactory, Priority priority)
StackDockStation
. Note that this property has to be set
before the theme is installed. Otherwise it will take no effect.
stackDockComponentFactory
- the factory or null
priority
- the importance of the new setting (whether it should override existing settings or not).public void setSpanFactory(SpanFactory factory)
Span
s. Note that this property
has to be set before the theme is installed, otherwise it will take not effect.
factory
- the new factory, can be null
public void setSpanFactory(SpanFactory factory, Priority priority)
Span
s. Note that this property
has to be set before the theme is installed. Otherwise it will take no effect.
factory
- the factory or null
priority
- the imprtance of the new setting (whether it should override existing settings or not).public void setMovingImageFactory(DockableMovingImageFactory movingImage)
Dockable
movingImage
- the new factorypublic void setMovingImageFactory(DockableMovingImageFactory movingImage, Priority priority)
Dockable
movingImage
- the new factorypriority
- the importance of the new setting (whether it should override existing settings or not).public void setCombiner(Combiner combiner)
Combiner
of this theme. The combiner is used to
merge two Dockables.
combiner
- the combinerpublic void setCombiner(Combiner combiner, Priority priority)
Combiner
of this theme. The combiner is used to
merge two Dockables.
combiner
- the combinerpriority
- the importance of the new setting (whether it should override existing settings or not).public void setPaint(StationPaint paint)
StationPaint
of this theme. The paint is used to
draw markings on stations.
paint
- the paintpublic void setPaint(StationPaint paint, Priority priority)
StationPaint
of this theme. The paint is used to
draw markings on stations.
paint
- the paintpriority
- the importance of the new setting (whether it should override existing settings or not).public void setDisplayerFactory(DisplayerFactory factory)
DisplayerFactory
of this theme. The factory is needed
to create DockableDisplayer
.
factory
- the factorypublic void setDisplayerFactory(DisplayerFactory factory, Priority priority)
DisplayerFactory
of this theme. The factory is needed
to create DockableDisplayer
.
factory
- the factorypriority
- the importance of the new setting (whether it should override existing settings or not).public void setTitleFactory(DockTitleFactory titleFactory)
DockTitleFactory
of this station. The factory is
used to create DockTitles
for some Dockables.
titleFactory
- the factorypublic void setTitleFactory(DockTitleFactory titleFactory, Priority priority)
DockTitleFactory
of this station. The factory is
used to create DockTitles
for some Dockables.
titleFactory
- the factorypriority
- the importance of the new setting (whether it should override existing settings or not).public void setDockableSelection(DockableSelection selection)
Dockable
.
selection
- the new selectorpublic void setDockableSelection(DockableSelection selection, Priority priority)
Dockable
.
selection
- the new selectorpriority
- the importance of the new setting (whether it should override existing settings or not).public void setTabPlacement(TabPlacement tabPlacement)
DockController
is installed, otherwise the
settings has no effect.
tabPlacement
- the side at which to show tabs, may be null
to
use the default valuepublic void setTabPlacement(TabPlacement tabPlacement, Priority priority)
DockController
is installed, otherwise the
settings has no effect.
tabPlacement
- the side at which to show tabs, may be null
to
use the default valuepriority
- the importance of the new setting (whether it should override existing settings or not).public TabPlacement getTabPlacement()
null
public DockableMovingImageFactory getMovingImageFactory(DockController controller)
DockTheme
DockTheme.DOCKABLE_MOVING_IMAGE_FACTORY
should be used.
getMovingImageFactory
in interface DockTheme
controller
- the controller for which the factory is needed
public Combiner getCombiner(DockStation station)
DockTheme
station
.UIValue
of type StationCombinerValue
should
be installed at the local ThemeManager
to retrieve the value.
getCombiner
in interface DockTheme
station
- the station whose combiner is searched
station
public StationPaint getPaint(DockStation station)
DockTheme
station
.UIValue
of type DefaultStationPaintValue
should
be installed at the local ThemeManager
to retrieve the value.
getPaint
in interface DockTheme
station
- the station to paint on
station
public DisplayerFactory getDisplayFactory(DockStation station)
DockTheme
station
.UIValue
of type DefaultDisplayerFactoryValue
should
be installed at the local ThemeManager
to retrieve the value.
getDisplayFactory
in interface DockTheme
station
- the station on which the created DockableDisplayer
is shown
public DockTitleFactory getTitleFactory(DockController controller)
DockTheme
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.
getTitleFactory
in interface DockTheme
controller
- the controller using this theme
public DockableSelection getDockableSelection(DockController controller)
DockTheme
Dockable
s. This method should not be invoked directly, instead
the property key DockTheme.DOCKABLE_SELECTION
should be used.
getDockableSelection
in interface DockTheme
controller
- the controller for which the selector will be used
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |