bibliothek.gui.dock.common.intern.color
Class TabColorTransmitter

java.lang.Object
  extended by bibliothek.gui.dock.common.intern.ui.UITransmitter<Color,DockColor>
      extended by bibliothek.gui.dock.common.intern.color.ColorTransmitter
          extended by bibliothek.gui.dock.common.intern.color.TabColorTransmitter
All Implemented Interfaces:
ColorBridge, UIBridge<Color,DockColor>
Direct Known Subclasses:
BasicTabTransmitter, BubbleTabTransmitter, EclipseTabTransmitter, FlatTabTransmitter

public abstract class TabColorTransmitter
extends ColorTransmitter

A ColorTransmitter used for TabColors.

Author:
Benjamin Sigg

Constructor Summary
TabColorTransmitter(ColorManager manager, String... keys)
          Creates a new transmitter.
 
Method Summary
protected abstract  Color convert(Color source, String key)
          Changes a background color such that it can be used on a StackDockComponent
protected abstract  Color convertFocused(Color source, String key)
          Changes a background color such that it can be used on a StackDockComponent
protected abstract  Color convertSelected(Color source, String key)
          Changes a background color such that it can be used on a StackDockComponent
protected  Color get(Color color, String id, CDockable dockable)
          Searches the color id for dockable.
protected  Color get(Color color, String id, DockColor observer)
          Called when a value needs to be set whose key has been registered at this UITransmitter.
protected  CDockable getDockable(DockColor observer)
          Gets the CDockable which is associated with observer.
protected abstract  boolean isFocused(String id)
          Tells whether id represents a color that is used on focused tabs.
protected abstract  boolean isForeground(String id)
          Tells whether id represents a color that is used for the foreground.
protected abstract  boolean isSelected(String id)
          Tells whether id represents a color that is used on selected tabs.
protected  void update(CDockable dockable, String key, Color color)
          Called when a value in an observed map has changed.
 
Methods inherited from class bibliothek.gui.dock.common.intern.color.ColorTransmitter
connect, disconnect, getFirstNonNull
 
Methods inherited from class bibliothek.gui.dock.common.intern.ui.UITransmitter
add, remove, set, set, setControl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.util.UIBridge
add, remove, set
 

Constructor Detail

TabColorTransmitter

public TabColorTransmitter(ColorManager manager,
                           String... keys)
Creates a new transmitter.

Parameters:
keys - the keys of the colors that are handled by this transmitter
manager - the source of all colors
Method Detail

convert

protected abstract Color convert(Color source,
                                 String key)
Changes a background color such that it can be used on a StackDockComponent

Parameters:
source - the original color
key - the key for which the color is needed
Returns:
the new color

convertSelected

protected abstract Color convertSelected(Color source,
                                         String key)
Changes a background color such that it can be used on a StackDockComponent

Parameters:
source - the original color
key - the key for which the color is needed, can be one of the selected or focused kind
Returns:
the new color

convertFocused

protected abstract Color convertFocused(Color source,
                                        String key)
Changes a background color such that it can be used on a StackDockComponent

Parameters:
source - the original color
key - the key for which the color is needed, can only be one of the focused kind
Returns:
the new color

get

protected Color get(Color color,
                    String id,
                    DockColor observer)
Description copied from class: UITransmitter
Called when a value needs to be set whose key has been registered at this UITransmitter.

Specified by:
get in class UITransmitter<Color,DockColor>
Parameters:
color - the original value
id - the key of the value
observer - the destination for the value
Returns:
the value that should be set to observer

isForeground

protected abstract boolean isForeground(String id)
Tells whether id represents a color that is used for the foreground.

Parameters:
id - some id
Returns:
true if the color is used in the foreground

isSelected

protected abstract boolean isSelected(String id)
Tells whether id represents a color that is used on selected tabs.

Parameters:
id - some id
Returns:
true if the color is used on selected tabs

isFocused

protected abstract boolean isFocused(String id)
Tells whether id represents a color that is used on focused tabs.

Parameters:
id - some id
Returns:
true if the color is used on focused tabs

get

protected Color get(Color color,
                    String id,
                    CDockable dockable)
Searches the color id for dockable.

Parameters:
color - the color to be returned if the search for id fails.
id - the identifier of the color to search
dockable - the element for which the color will be used
Returns:
some color

update

protected void update(CDockable dockable,
                      String key,
                      Color color)
Description copied from class: UITransmitter
Called when a value in an observed map has changed.

Specified by:
update in class UITransmitter<Color,DockColor>
Parameters:
dockable - the owner of the map
key - the name of the changed value
color - the new value in the map, can be null

getDockable

protected CDockable getDockable(DockColor observer)
Description copied from class: UITransmitter
Gets the CDockable which is associated with observer.

Specified by:
getDockable in class UITransmitter<Color,DockColor>
Parameters:
observer - some observer
Returns:
the associated dockable or null