01: /*******************************************************************************
02: * Copyright (c) 2004, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.themes;
11:
12: import org.eclipse.jface.util.IPropertyChangeListener;
13:
14: /**
15: * A theme manager is an object that contains references to usable
16: * <code>ITheme</code> objects and maintains a reference to the currently active
17: * theme. This theme will be used by the workbench to decorate tab folders and
18: * other controls where possible. The workbench implementation of this
19: * interface will push the values of the current theme into the underlying jface
20: * registries ({@link org.eclipse.jface.resource.ColorRegistry} and
21: * {@link org.eclipse.jface.resource.FontRegistry} whenever the current theme
22: * changes. Clients who do not need access to specific themes may instead
23: * attach listeners to these registries directly.
24: *
25: * <p>
26: * This interface is not intended to be implemented or extended by clients.
27: * </p>
28: *
29: * @see org.eclipse.ui.IWorkbench#getThemeManager()
30: * @since 3.0
31: */
32: public interface IThemeManager {
33:
34: /**
35: * Indicates that the current theme has changed to a new theme.
36: */
37: public static final String CHANGE_CURRENT_THEME = "CHANGE_CURRENT_THEME"; //$NON-NLS-1$
38:
39: /**
40: * The default theme id.
41: */
42: public static final String DEFAULT_THEME = "org.eclipse.ui.defaultTheme"; //$NON-NLS-1$
43:
44: /**
45: * Adds a property listener to the manager. Any events fired by the
46: * underlying registries of the current theme will cause an event to be
47: * fired. This event is the same event that was fired by the registry.
48: * As such, the "source" attribute of the event will not be this manager,
49: * but rather the color or font registry. Additionally, an event is fired
50: * when the current theme changes to a new theme. The "property" attribute
51: * of such an event will have the value {@link IThemeManager#CHANGE_CURRENT_THEME}.
52: *
53: * @param listener the listener to add
54: */
55: void addPropertyChangeListener(IPropertyChangeListener listener);
56:
57: /**
58: * Get the currently active theme.
59: *
60: * @return the current theme. This will never be <code>null</code>.
61: */
62: ITheme getCurrentTheme();
63:
64: /**
65: * Get a theme.
66: *
67: * @param id the theme to find.
68: * @return the <code>ITheme</code> or <code>null</code> if it cannot be found.
69: */
70: ITheme getTheme(String id);
71:
72: /**
73: * Removes a property listener from the workbench.
74: *
75: * @param listener the listener to remove
76: */
77: void removePropertyChangeListener(IPropertyChangeListener listener);
78:
79: /**
80: * Set the currently active theme.
81: *
82: * @param id the id of the new active theme
83: */
84: void setCurrentTheme(String id);
85: }
|