Eclipse Platform
Release 3.2

org.eclipse.ui.themes
Interface ITheme


public interface ITheme

A theme is a collection of colors, fonts and supporting data that may be used by plugins to help provide uniform look and feel to their components. The workbench has a default theme (one whos id has the value IThemeManager.DEFAULT_THEME) that defines the initial values for a collection of fonts and colors. Other themes may extend and override the default theme to provide new values.

Clients may obtain themes via IThemeManager.getTheme(String).

This interface is not intended to be implemented or extended by clients.

Since:
3.0
See Also:
IWorkbench.getThemeManager()

Method Summary
 void addPropertyChangeListener(IPropertyChangeListener listener)
          Adds a property listener to the theme.
 void dispose()
          Dispose of this theme.
 boolean getBoolean(java.lang.String key)
          Get arbitrary data associated with this theme.
 ColorRegistry getColorRegistry()
          Return this themes color registry.
 FontRegistry getFontRegistry()
          Return this themes font registry.
 java.lang.String getId()
          Returns the id of this theme.
 int getInt(java.lang.String key)
          Get arbitrary data associated with this theme.
 java.lang.String getLabel()
          Returns the label of this theme.
 java.lang.String getString(java.lang.String key)
          Get arbitrary data associated with this theme.
 java.util.Set keySet()
          Get the set of keys associated with this theme.
 void removePropertyChangeListener(IPropertyChangeListener listener)
          Removes a property listener from the theme.
 

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property listener to the theme. Any events fired by the underlying registries will cause an event to be fired. This event is the same event that was fired by the registry. As such, the "source" attribute of the event will not be this theme, but rather the color or font registry.

Parameters:
listener - the listener to add

dispose

void dispose()
Dispose of this theme. This method is called by the workbench when appropriate and should never be called by a user.


getBoolean

boolean getBoolean(java.lang.String key)
Get arbitrary data associated with this theme.

Parameters:
key - the key
Returns:
the data, or the default value false if none exists or if the value cannot be treated as a boolean.

getColorRegistry

ColorRegistry getColorRegistry()
Return this themes color registry.

Returns:
this themes color registry

getFontRegistry

FontRegistry getFontRegistry()
Return this themes font registry.

Returns:
this themes font registry

getId

java.lang.String getId()
Returns the id of this theme.

Returns:
the id of this theme. Guaranteed not to be null.

getInt

int getInt(java.lang.String key)
Get arbitrary data associated with this theme.

Parameters:
key - the key
Returns:
the data, or the default value 0 if none exists or if the value cannot be treated as an integer.

getLabel

java.lang.String getLabel()
Returns the label of this theme.

Returns:
the label of this theme. Guaranteed not be null.

getString

java.lang.String getString(java.lang.String key)
Get arbitrary data associated with this theme.

Parameters:
key - the key
Returns:
the data, or null if none exists.

keySet

java.util.Set keySet()
Get the set of keys associated with this theme.

Returns:
the Set of keys

removePropertyChangeListener

void removePropertyChangeListener(IPropertyChangeListener listener)
Removes a property listener from the theme.

Parameters:
listener - the listener to remove

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.