[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: api docs for LookAndFeel, DefaultMetalTheme, MetalLook
From: |
David Gilbert |
Subject: |
[cp-patches] FYI: api docs for LookAndFeel, DefaultMetalTheme, MetalLookAndFeel and MetalTheme |
Date: |
Wed, 13 Jul 2005 12:57:19 +0000 |
User-agent: |
Mozilla Thunderbird 1.0.2 (X11/20050426) |
I committed this patch to fill out some API docs:
2005-07-13 David Gilbert <address@hidden>
* javax/swing/LookAndFeel.java: added API docs all over,
* javax/swing/plaf/metal/DefaultMetalTheme.java: likewise,
* javax/swing/plaf/metal/MetalLookAndFeel.java: likewise,
* javax/swing/plaf/metal/MetalTheme.java: likewise.
Regards,
Dave Gilbert
Index: javax/swing/LookAndFeel.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/LookAndFeel.java,v
retrieving revision 1.10
diff -u -r1.10 LookAndFeel.java
--- javax/swing/LookAndFeel.java 2 Jul 2005 20:32:49 -0000 1.10
+++ javax/swing/LookAndFeel.java 13 Jul 2005 11:49:28 -0000
@@ -1,5 +1,5 @@
/* LookAndFeel.java --
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -56,16 +56,32 @@
return null;
}
+ /**
+ * Returns a description of the look and feel.
+ *
+ * @return A description of the look and feel.
+ */
public abstract String getDescription();
- public static Object getDesktopPropertyValue(String systemPropertyName,
Object fallbackValue)
+ public static Object getDesktopPropertyValue(String systemPropertyName,
+ Object fallbackValue)
{
Object value =
Toolkit.getDefaultToolkit().getDesktopProperty(systemPropertyName);
return value != null ? value : fallbackValue;
}
+ /**
+ * Returns an identifier for the look and feel.
+ *
+ * @return An identifier for the look and feel.
+ */
public abstract String getID();
+ /**
+ * Returns the name for the look and feel.
+ *
+ * @return The name for the look and feel.
+ */
public abstract String getName();
/**
@@ -118,8 +134,25 @@
{
}
+ /**
+ * Returns <code>true</code> if the look and feel is the "native" look and
+ * feel for the current platform, and <code>false</code> otherwise.
+ *
+ * @return A flag indicating whether or not this is the native look and feel
+ * for the current platform.
+ */
public abstract boolean isNativeLookAndFeel();
+ /**
+ * Returns <code>true</code> if the look and feel is supported on the
+ * current operating system, and <code>false</code> otherwise. This
+ * mechanism is provided so that it is possible to prevent a look and feel
+ * from being used on some operating systems (usually for legal, not
+ * technical, reasons).
+ *
+ * @return A flag indicating whether or not the look and feel is supported
+ * on the current platform.
+ */
public abstract boolean isSupportedLookAndFeel();
/**
Index: javax/swing/plaf/metal/DefaultMetalTheme.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/swing/plaf/metal/DefaultMetalTheme.java,v
retrieving revision 1.3
diff -u -r1.3 DefaultMetalTheme.java
--- javax/swing/plaf/metal/DefaultMetalTheme.java 2 Jul 2005 20:32:50
-0000 1.3
+++ javax/swing/plaf/metal/DefaultMetalTheme.java 13 Jul 2005 11:49:29
-0000
@@ -1,5 +1,5 @@
/* DefaultMetalTheme.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -43,6 +43,11 @@
import javax.swing.plaf.ColorUIResource;
import javax.swing.plaf.FontUIResource;
+/**
+ * The default theme for the address@hidden MetalLookAndFeel}.
+ *
+ * @see MetalLookAndFeel#setCurrentTheme(MetalTheme)
+ */
public class DefaultMetalTheme extends MetalTheme
{
private static final ColorUIResource PRIMARY1 =
@@ -71,71 +76,144 @@
private static final FontUIResource WINDOW_TITLE_FONT =
new FontUIResource("Dialog", Font.BOLD, 12);
+ /**
+ * Creates a new instance of this theme.
+ */
public DefaultMetalTheme()
{
// Do nothing here.
}
+ /**
+ * Returns the name of the theme.
+ *
+ * @return <code>"Steel"</code>.
+ */
public String getName()
{
return "Steel";
}
+ /**
+ * Returns the first primary color for this theme.
+ *
+ * @return The first primary color.
+ */
protected ColorUIResource getPrimary1()
{
return PRIMARY1;
}
+ /**
+ * Returns the second primary color for this theme.
+ *
+ * @return The second primary color.
+ */
protected ColorUIResource getPrimary2()
{
return PRIMARY2;
}
+ /**
+ * Returns the third primary color for this theme.
+ *
+ * @return The third primary color.
+ */
protected ColorUIResource getPrimary3()
{
return PRIMARY3;
}
+ /**
+ * Returns the first secondary color for this theme.
+ *
+ * @return The first secondary color.
+ */
protected ColorUIResource getSecondary1()
{
return SECONDARY1;
}
+ /**
+ * Returns the second secondary color for this theme.
+ *
+ * @return The second secondary color.
+ */
protected ColorUIResource getSecondary2()
{
return SECONDARY2;
}
+ /**
+ * Returns the third secondary color for this theme.
+ *
+ * @return The third secondary color.
+ */
protected ColorUIResource getSecondary3()
{
return SECONDARY3;
}
+ /**
+ * Returns the font used for text on controls. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.BOLD, 12)</code>.
+ *
+ * @return The font.
+ */
public FontUIResource getControlTextFont()
{
return CONTROL_TEXT_FONT;
}
-
+ /**
+ * Returns the font used for text in menus. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.BOLD, 12)</code>.
+ *
+ * @return The font used for text in menus.
+ */
public FontUIResource getMenuTextFont()
{
return MENU_TEXT_FONT;
}
+ /**
+ * Returns the font used for sub text. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.PLAIN, 10)</code>.
+ *
+ * @return The font used for sub text.
+ */
public FontUIResource getSubTextFont()
{
return SUB_TEXT_FONT;
}
+ /**
+ * Returns the font used for system text. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.PLAIN, 12)</code>.
+ *
+ * @return The font used for system text.
+ */
public FontUIResource getSystemTextFont()
{
return SYSTEM_TEXT_FONT;
}
+ /**
+ * Returns the font used for user text. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.PLAIN, 12)</code>.
+ *
+ * @return The font used for user text.
+ */
public FontUIResource getUserTextFont()
{
return USER_TEXT_FONT;
}
+ /**
+ * Returns the font used for window titles. In this case, the font is
+ * <code>FontUIResource("Dialog", Font.BOLD, 12)</code>.
+ *
+ * @return The font used for window titles.
+ */
public FontUIResource getWindowTitleFont()
{
return WINDOW_TITLE_FONT;
Index: javax/swing/plaf/metal/MetalLookAndFeel.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/swing/plaf/metal/MetalLookAndFeel.java,v
retrieving revision 1.26
diff -u -r1.26 MetalLookAndFeel.java
--- javax/swing/plaf/metal/MetalLookAndFeel.java 12 Jul 2005 18:58:00
-0000 1.26
+++ javax/swing/plaf/metal/MetalLookAndFeel.java 13 Jul 2005 11:49:30
-0000
@@ -38,7 +38,6 @@
package javax.swing.plaf.metal;
-import java.awt.Color;
import java.awt.Insets;
import javax.swing.ImageIcon;
@@ -48,42 +47,85 @@
import javax.swing.plaf.IconUIResource;
import javax.swing.plaf.basic.BasicLookAndFeel;
+/**
+ * A custom look and feel that is designed to look similar across different
+ * operating systems.
+ */
public class MetalLookAndFeel extends BasicLookAndFeel
{
private static final long serialVersionUID = 6680646159193457980L;
+
+ /** The current theme. */
private static MetalTheme theme;
+
+ /** The look and feel defaults. */
private UIDefaults LAF_defaults;
+ /**
+ * Creates a new instance of the Metal look and feel.
+ */
public MetalLookAndFeel()
{
createDefaultTheme();
}
+ /**
+ * Sets the current theme to a new instance of address@hidden
DefaultMetalTheme}.
+ */
protected void createDefaultTheme()
{
setCurrentTheme(new DefaultMetalTheme());
}
+ /**
+ * Returns <code>false</code> to indicate that this look and feel does not
+ * attempt to emulate the look and feel of native applications on the host
+ * platform.
+ *
+ * @return <code>false</code>.
+ */
public boolean isNativeLookAndFeel()
{
return false;
}
+ /**
+ * Returns <code>true</code> to indicate that this look and feel is supported
+ * on all platforms.
+ *
+ * @return <code>true</code>.
+ */
public boolean isSupportedLookAndFeel()
{
return true;
}
+ /**
+ * Returns a string describing the look and feel. In this case, the method
+ * returns "Metal look and feel".
+ *
+ * @return A string describing the look and feel.
+ */
public String getDescription()
{
return "Metal look and feel";
}
+ /**
+ * Returns the look and feel identifier.
+ *
+ * @return "MetalLookAndFeel".
+ */
public String getID()
{
return "MetalLookAndFeel";
}
+ /**
+ * Returns the look and feel name.
+ *
+ * @return "MetalLookAndFeel".
+ */
public String getName()
{
return "MetalLookAndFeel";
@@ -103,216 +145,463 @@
return LAF_defaults;
}
+ /**
+ * Returns the accelerator foreground color from the installed theme.
+ *
+ * @return The accelerator foreground color.
+ */
public static ColorUIResource getAcceleratorForeground()
{
return theme.getAcceleratorForeground();
}
+ /**
+ * Returns the accelerator selected foreground color from the installed
+ * theme.
+ *
+ * @return The accelerator selected foreground color.
+ */
public static ColorUIResource getAcceleratorSelectedForeground()
{
return theme.getAcceleratorSelectedForeground();
}
+ /**
+ * Returns the color black from the installed theme.
+ *
+ * @return The color black.
+ */
public static ColorUIResource getBlack()
{
return theme.getBlack();
}
+ /**
+ * Returns the control color from the installed theme.
+ *
+ * @return The control color.
+ */
public static ColorUIResource getControl()
{
return theme.getControl();
}
+ /**
+ * Returns the color used for dark shadows on controls, from the installed
+ * theme.
+ *
+ * @return The color used for dark shadows on controls.
+ */
public static ColorUIResource getControlDarkShadow()
{
return theme.getControlDarkShadow();
}
+ /**
+ * Returns the color used for disabled controls, from the installed theme.
+ *
+ * @return The color used for disabled controls.
+ */
public static ColorUIResource getControlDisabled()
{
return theme.getControlDisabled();
}
+ /**
+ * Returns the color used to draw highlights for controls, from the installed
+ * theme.
+ *
+ * @return The color used to draw highlights for controls.
+ */
public static ColorUIResource getControlHighlight()
{
return theme.getControlHighlight();
}
+ /**
+ * Returns the color used to display control info, from the installed
+ * theme.
+ *
+ * @return The color used to display control info.
+ */
public static ColorUIResource getControlInfo()
{
return theme.getControlInfo();
}
+ /**
+ * Returns the color used to draw shadows for controls, from the installed
+ * theme.
+ *
+ * @return The color used to draw shadows for controls.
+ */
public static ColorUIResource getControlShadow()
{
return theme.getControlShadow();
}
+ /**
+ * Returns the color used for text on controls, from the installed theme.
+ *
+ * @return The color used for text on controls.
+ */
public static ColorUIResource getControlTextColor()
{
return theme.getControlTextColor();
}
+ /**
+ * Returns the font used for text on controls, from the installed theme.
+ *
+ * @return The font used for text on controls.
+ */
public static FontUIResource getControlTextFont()
{
return theme.getControlTextFont();
}
+ /**
+ * Returns the color used for the desktop background, from the installed
+ * theme.
+ *
+ * @return The color used for the desktop background.
+ */
public static ColorUIResource getDesktopColor()
{
return theme.getDesktopColor();
}
+ /**
+ * Returns the color used to draw focus highlights, from the installed
+ * theme.
+ *
+ * @return The color used to draw focus highlights.
+ */
public static ColorUIResource getFocusColor()
{
return theme.getFocusColor();
}
+ /**
+ * Returns the color used to draw highlighted text, from the installed
+ * theme.
+ *
+ * @return The color used to draw highlighted text.
+ */
public static ColorUIResource getHighlightedTextColor()
{
return theme.getHighlightedTextColor();
}
+ /**
+ * Returns the color used to draw text on inactive controls, from the
+ * installed theme.
+ *
+ * @return The color used to draw text on inactive controls.
+ */
public static ColorUIResource getInactiveControlTextColor()
{
return theme.getInactiveControlTextColor();
}
+ /**
+ * Returns the color used to draw inactive system text, from the installed
+ * theme.
+ *
+ * @return The color used to draw inactive system text.
+ */
public static ColorUIResource getInactiveSystemTextColor()
{
return theme.getInactiveSystemTextColor();
}
+ /**
+ * Returns the background color for menu items, from the installed theme.
+ *
+ * @return The background color for menu items.
+ *
+ * @see #getMenuSelectedBackground()
+ */
public static ColorUIResource getMenuBackground()
{
return theme.getMenuBackground();
}
+ /**
+ * Returns the foreground color for disabled menu items, from the installed
+ * theme.
+ *
+ * @return The foreground color for disabled menu items.
+ *
+ * @see #getMenuForeground()
+ */
public static ColorUIResource getMenuDisabledForeground()
{
return theme.getMenuDisabledForeground();
}
+ /**
+ * Returns the foreground color for menu items, from the installed theme.
+ *
+ * @return The foreground color for menu items.
+ *
+ * @see #getMenuDisabledForeground()
+ * @see #getMenuSelectedForeground()
+ */
public static ColorUIResource getMenuForeground()
{
return theme.getMenuForeground();
}
+ /**
+ * Returns the background color for selected menu items, from the installed
+ * theme.
+ *
+ * @return The background color for selected menu items.
+ *
+ * @see #getMenuBackground()
+ */
public static ColorUIResource getMenuSelectedBackground()
{
return theme.getMenuSelectedBackground();
}
+ /**
+ * Returns the foreground color for selected menu items, from the installed
+ * theme.
+ *
+ * @return The foreground color for selected menu items.
+ *
+ * @see #getMenuForeground()
+ */
public static ColorUIResource getMenuSelectedForeground()
{
return theme.getMenuSelectedForeground();
}
+ /**
+ * Returns the font used for text in menus, from the installed theme.
+ *
+ * @return The font used for text in menus.
+ */
public static FontUIResource getMenuTextFont()
{
return theme.getMenuTextFont();
}
+ /**
+ * Returns the primary color for controls, from the installed theme.
+ *
+ * @return The primary color for controls.
+ */
public static ColorUIResource getPrimaryControl()
{
return theme.getPrimaryControl();
}
+ /**
+ * Returns the primary color for the dark shadow on controls, from the
+ * installed theme.
+ *
+ * @return The primary color for the dark shadow on controls.
+ */
public static ColorUIResource getPrimaryControlDarkShadow()
{
return theme.getPrimaryControlDarkShadow();
}
+ /**
+ * Returns the primary color for the highlight on controls, from the
+ * installed theme.
+ *
+ * @return The primary color for the highlight on controls.
+ */
public static ColorUIResource getPrimaryControlHighlight()
{
return theme.getPrimaryControlHighlight();
}
+ /**
+ * Returns the primary color for the information on controls, from the
+ * installed theme.
+ *
+ * @return The primary color for the information on controls.
+ */
public static ColorUIResource getPrimaryControlInfo()
{
return theme.getPrimaryControlInfo();
}
+ /**
+ * Returns the primary color for the shadow on controls, from the installed
+ * theme.
+ *
+ * @return The primary color for the shadow on controls.
+ */
public static ColorUIResource getPrimaryControlShadow()
{
return theme.getPrimaryControlShadow();
}
+ /**
+ * Returns the background color for separators, from the installed theme.
+ *
+ * @return The background color for separators.
+ */
public static ColorUIResource getSeparatorBackground()
{
return theme.getSeparatorBackground();
}
+ /**
+ * Returns the foreground color for separators, from the installed theme.
+ *
+ * @return The foreground color for separators.
+ */
public static ColorUIResource getSeparatorForeground()
{
return theme.getSeparatorForeground();
}
+ /**
+ * Returns the font used for sub text, from the installed theme.
+ *
+ * @return The font used for sub text.
+ */
public static FontUIResource getSubTextFont()
{
return theme.getSubTextFont();
}
+ /**
+ * Returns the color used for system text, from the installed theme.
+ *
+ * @return The color used for system text.
+ */
public static ColorUIResource getSystemTextColor()
{
return theme.getSystemTextColor();
}
+ /**
+ * Returns the font used for system text, from the installed theme.
+ *
+ * @return The font used for system text.
+ */
public static FontUIResource getSystemTextFont()
{
return theme.getSystemTextFont();
}
+ /**
+ * Returns the color used to highlight text, from the installed theme.
+ *
+ * @return The color used to highlight text.
+ */
public static ColorUIResource getTextHighlightColor()
{
return theme.getTextHighlightColor();
}
+ /**
+ * Returns the color used to display user text, from the installed theme.
+ *
+ * @return The color used to display user text.
+ */
public static ColorUIResource getUserTextColor()
{
return theme.getUserTextColor();
}
+ /**
+ * Returns the font used for user text, obtained from the current theme.
+ *
+ * @return The font used for user text.
+ */
public static FontUIResource getUserTextFont()
{
return theme.getUserTextFont();
}
+ /**
+ * Returns the color used for white, from the installed theme.
+ *
+ * @return The color used for white.
+ */
public static ColorUIResource getWhite()
{
return theme.getWhite();
}
+ /**
+ * Returns the window background color, from the installed theme.
+ *
+ * @return The window background color.
+ */
public static ColorUIResource getWindowBackground()
{
return theme.getWindowBackground();
}
+ /**
+ * Returns the window title background color, from the installed theme.
+ *
+ * @return The window title background color.
+ */
public static ColorUIResource getWindowTitleBackground()
{
return theme.getWindowTitleBackground();
}
+ /**
+ * Returns the window title font from the current theme.
+ *
+ * @return The window title font.
+ *
+ * @see MetalTheme
+ */
public static FontUIResource getWindowTitleFont()
{
return theme.getWindowTitleFont();
}
+ /**
+ * Returns the window title foreground color, from the installed theme.
+ *
+ * @return The window title foreground color.
+ */
public static ColorUIResource getWindowTitleForeground()
{
return theme.getWindowTitleForeground();
}
+ /**
+ * Returns the background color for an inactive window title, from the
+ * installed theme.
+ *
+ * @return The background color for an inactive window title.
+ */
public static ColorUIResource getWindowTitleInactiveBackground()
{
return theme.getWindowTitleInactiveBackground();
}
+ /**
+ * Returns the foreground color for an inactive window title, from the
+ * installed theme.
+ *
+ * @return The foreground color for an inactive window title.
+ */
public static ColorUIResource getWindowTitleInactiveForeground()
{
return theme.getWindowTitleInactiveForeground();
}
+ /**
+ * Sets the current theme for the look and feel.
+ *
+ * @param theme the theme.
+ */
public static void setCurrentTheme(MetalTheme theme)
{
MetalLookAndFeel.theme = theme;
@@ -421,7 +710,7 @@
* </tr><tr>
* <td>Button.background</td><td>0xcccccc</td>
* </tr><tr>
- * <td>Button.border</td><td>address@hidden MetalBorders.ButtonBorder}</td>
+ * <td>Button.border</td><td>address@hidden
MetalBorders#getButtonBorder()}</td>
* </tr><tr>
* <td>Button.font</td><td>address@hidden #getControlTextFont}</td>
* </tr><tr>
Index: javax/swing/plaf/metal/MetalTheme.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/plaf/metal/MetalTheme.java,v
retrieving revision 1.5
diff -u -r1.5 MetalTheme.java
--- javax/swing/plaf/metal/MetalTheme.java 2 Jul 2005 20:32:51 -0000
1.5
+++ javax/swing/plaf/metal/MetalTheme.java 13 Jul 2005 11:49:30 -0000
@@ -1,5 +1,5 @@
/* MetalTheme.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -45,215 +45,532 @@
import javax.swing.plaf.ColorUIResource;
import javax.swing.plaf.FontUIResource;
+/**
+ * The base class for themes used by the address@hidden MetalLookAndFeel}. A
default
+ * theme (address@hidden DefaultMetalTheme}) is provided, or you can create
and use
+ * your own.
+ *
+ * @see MetalLookAndFeel#setCurrentTheme(MetalTheme)
+ */
public abstract class MetalTheme
{
private ColorUIResource BLACK = new ColorUIResource(Color.BLACK);
private ColorUIResource WHITE = new ColorUIResource(Color.WHITE);
+ /**
+ * Default constructor.
+ */
public MetalTheme()
{
// Do nothing here.
}
+ /**
+ * Returns the name of the theme.
+ *
+ * @return The name of the theme.
+ */
public abstract String getName();
+ /**
+ * Adds custom entries to the UI defaults table. This method is empty.
+ *
+ * @param table the table.
+ */
public void addCustomEntriesToTable(UIDefaults table)
{
// Do nothing here.
- // This method needs to be overloaded to actuall do something.
+ // This method needs to be overridden to actually do something.
+ // It is called from MetalLookAndFeel.getDefaults().
}
+ /**
+ * Returns the accelerator foreground color. The default implementation
+ * returns the color from address@hidden #getPrimary1()}.
+ *
+ * @return The accelerator foreground color.
+ */
public ColorUIResource getAcceleratorForeground()
{
return getPrimary1();
}
+ /**
+ * Returns the accelerator selected foreground color. The default
+ * implementation returns the color from address@hidden #getBlack()}.
+ *
+ * @return The accelerator selected foreground color.
+ */
public ColorUIResource getAcceleratorSelectedForeground()
{
return getBlack();
}
+ /**
+ * Returns the control color. The default implementation returns the color
+ * from address@hidden #getSecondary3()}.
+ *
+ * @return The control color.
+ */
public ColorUIResource getControl()
{
return getSecondary3();
}
+ /**
+ * Returns the color used for dark shadows on controls. The default
+ * implementation returns the color from address@hidden #getSecondary1()}.
+ *
+ * @return The color used for dark shadows on controls.
+ */
public ColorUIResource getControlDarkShadow()
{
return getSecondary1();
}
+ /**
+ * Returns the color used for disabled controls. The default implementation
+ * returns the color from address@hidden #getSecondary1()}.
+ *
+ * @return The color used for disabled controls.
+ */
public ColorUIResource getControlDisabled()
{
return getSecondary2();
}
+ /**
+ * Returns the color used to draw highlights for controls. The default
+ * implementation returns the color from address@hidden #getWhite()}.
+ *
+ * @return The color used to draw highlights for controls.
+ */
public ColorUIResource getControlHighlight()
{
return getWhite();
}
+ /**
+ * Returns the color used to display control info. The default
+ * implementation returns the color from address@hidden #getBlack()}.
+ *
+ * @return The color used to display control info.
+ */
public ColorUIResource getControlInfo()
{
return getBlack();
}
+ /**
+ * Returns the color used to draw shadows for controls. The default
+ * implementation returns the color from address@hidden #getSecondary2()}.
+ *
+ * @return The color used to draw shadows for controls.
+ */
public ColorUIResource getControlShadow()
{
return getSecondary2();
}
+ /**
+ * Returns the color used for text on controls. The default implementation
+ * returns the color from address@hidden #getControlInfo()}.
+ *
+ * @return The color used for text on controls.
+ */
public ColorUIResource getControlTextColor()
{
return getControlInfo();
}
+ /**
+ * Returns the color used for the desktop background. The default
+ * implementation returns the color from address@hidden #getPrimary2()}.
+ *
+ * @return The color used for the desktop background.
+ */
public ColorUIResource getDesktopColor()
{
return getPrimary2();
}
+ /**
+ * Returns the color used to draw focus highlights. The default
+ * implementation returns the color from address@hidden #getPrimary2()}.
+ *
+ * @return The color used to draw focus highlights.
+ */
public ColorUIResource getFocusColor()
{
return getPrimary2();
}
+ /**
+ * Returns the color used to draw highlighted text. The default
+ * implementation returns the color from address@hidden
#getHighlightedTextColor()}.
+ *
+ * @return The color used to draw highlighted text.
+ */
public ColorUIResource getHighlightedTextColor()
{
return getControlTextColor();
}
+ /**
+ * Returns the color used to draw text on inactive controls. The default
+ * implementation returns the color from address@hidden
#getControlDisabled()}.
+ *
+ * @return The color used to draw text on inactive controls.
+ */
public ColorUIResource getInactiveControlTextColor()
{
return getControlDisabled();
}
+ /**
+ * Returns the color used to draw inactive system text. The default
+ * implementation returns the color from address@hidden #getSecondary2()}.
+ *
+ * @return The color used to draw inactive system text.
+ */
public ColorUIResource getInactiveSystemTextColor()
{
return getSecondary2();
}
+ /**
+ * Returns the background color for menu items. The default implementation
+ * returns the color from address@hidden #getSecondary3()}.
+ *
+ * @return The background color for menu items.
+ *
+ * @see #getMenuSelectedBackground()
+ */
public ColorUIResource getMenuBackground()
{
return getSecondary3();
}
+ /**
+ * Returns the foreground color for disabled menu items. The default
+ * implementation returns the color from address@hidden #getSecondary2()}.
+ *
+ * @return The foreground color for disabled menu items.
+ *
+ * @see #getMenuForeground()
+ */
public ColorUIResource getMenuDisabledForeground()
{
return getSecondary2();
}
+ /**
+ * Returns the foreground color for menu items. The default implementation
+ * returns the color from address@hidden #getBlack()}.
+ *
+ * @return The foreground color for menu items.
+ *
+ * @see #getMenuDisabledForeground()
+ * @see #getMenuSelectedForeground()
+ */
public ColorUIResource getMenuForeground()
{
return getBlack();
}
+ /**
+ * Returns the background color for selected menu items. The default
+ * implementation returns the color from address@hidden #getPrimary2()}.
+ *
+ * @return The background color for selected menu items.
+ *
+ * @see #getMenuBackground()
+ */
public ColorUIResource getMenuSelectedBackground()
{
return getPrimary2();
}
+ /**
+ * Returns the foreground color for selected menu items. The default
+ * implementation returns the value from address@hidden #getBlack()}.
+ *
+ * @return The foreground color for selected menu items.
+ *
+ * @see #getMenuForeground()
+ */
public ColorUIResource getMenuSelectedForeground()
{
return getBlack();
}
+ /**
+ * Returns the primary color for controls. The default implementation
+ * returns the color from address@hidden #getPrimary3()}.
+ *
+ * @return The primary color for controls.
+ */
public ColorUIResource getPrimaryControl()
{
return getPrimary3();
}
+ /**
+ * Returns the primary color for the dark shadow on controls. The default
+ * implementation returns the color from address@hidden #getPrimary1()}.
+ *
+ * @return The primary color for the dark shadow on controls.
+ */
public ColorUIResource getPrimaryControlDarkShadow()
{
return getPrimary1();
}
+ /**
+ * Returns the primary color for the highlight on controls. The default
+ * implementation returns the color from address@hidden #getWhite()}.
+ *
+ * @return The primary color for the highlight on controls.
+ */
public ColorUIResource getPrimaryControlHighlight()
{
return getWhite();
}
+ /**
+ * Returns the primary color for the information on controls. The default
+ * implementation returns the color from address@hidden #getBlack()}.
+ *
+ * @return The primary color for the information on controls.
+ */
public ColorUIResource getPrimaryControlInfo()
{
return getBlack();
}
+ /**
+ * Returns the primary color for the shadow on controls. The default
+ * implementation returns the color from address@hidden #getPrimary2()}.
+ *
+ * @return The primary color for the shadow on controls.
+ */
public ColorUIResource getPrimaryControlShadow()
{
return getPrimary2();
}
+ /**
+ * Returns the background color for separators. The default implementation
+ * returns the color from address@hidden #getWhite()}.
+ *
+ * @return The background color for separators.
+ */
public ColorUIResource getSeparatorBackground()
{
return getWhite();
}
+ /**
+ * Returns the foreground color for separators. The default implementation
+ * returns the value from address@hidden #getPrimary1()}.
+ *
+ * @return The foreground color for separators.
+ */
public ColorUIResource getSeparatorForeground()
{
return getPrimary1();
}
+ /**
+ * Returns the color used for system text. The default implementation
+ * returns the color from address@hidden #getBlack()}.
+ *
+ * @return The color used for system text.
+ */
public ColorUIResource getSystemTextColor()
{
return getBlack();
}
+ /**
+ * Returns the color used to highlight text. The default implementation
+ * returns the color from address@hidden #getPrimary3()}.
+ *
+ * @return The color used to highlight text.
+ */
public ColorUIResource getTextHighlightColor()
{
return getPrimary3();
}
+ /**
+ * Returns the color used to display user text. The default implementation
+ * returns the color from address@hidden #getBlack()}.
+ *
+ * @return The color used to display user text.
+ */
public ColorUIResource getUserTextColor()
{
return getBlack();
}
+ /**
+ * Returns the window background color. The default implementation returns
+ * the color from address@hidden #getWhite()}.
+ *
+ * @return The window background color.
+ */
public ColorUIResource getWindowBackground()
{
return getWhite();
}
+ /**
+ * Returns the window title background color. The default implementation
+ * returns the color from address@hidden #getPrimary3()}.
+ *
+ * @return The window title background color.
+ */
public ColorUIResource getWindowTitleBackground()
{
return getPrimary3();
}
+ /**
+ * Returns the window title foreground color. The default implementation
+ * returns the color from address@hidden #getBlack()}.
+ *
+ * @return The window title foreground color.
+ */
public ColorUIResource getWindowTitleForeground()
{
return getBlack();
}
+ /**
+ * Returns the background color for an inactive window title. The default
+ * implementation returns the color from address@hidden #getSecondary3()}.
+ *
+ * @return The background color for an inactive window title.
+ */
public ColorUIResource getWindowTitleInactiveBackground()
{
return getSecondary3();
}
+ /**
+ * Returns the foreground color for an inactive window title. The default
+ * implementation returns the color from address@hidden #getBlack()}.
+ *
+ * @return The foreground color for an inactive window title.
+ */
public ColorUIResource getWindowTitleInactiveForeground()
{
return getBlack();
}
+ /**
+ * Returns the color used for black.
+ *
+ * @return The color used for black.
+ */
protected ColorUIResource getBlack()
{
return BLACK;
}
+ /**
+ * Returns the color used for white.
+ *
+ * @return The color used for white.
+ */
protected ColorUIResource getWhite()
{
return WHITE;
}
+ /**
+ * Returns the first primary color for this theme.
+ *
+ * @return The first primary color.
+ */
protected abstract ColorUIResource getPrimary1();
+
+ /**
+ * Returns the second primary color for this theme.
+ *
+ * @return The second primary color.
+ */
protected abstract ColorUIResource getPrimary2();
+
+ /**
+ * Returns the third primary color for this theme.
+ *
+ * @return The third primary color.
+ */
protected abstract ColorUIResource getPrimary3();
+
+ /**
+ * Returns the first secondary color for this theme.
+ *
+ * @return The first secondary color.
+ */
protected abstract ColorUIResource getSecondary1();
+
+ /**
+ * Returns the second secondary color for this theme.
+ *
+ * @return The second secondary color.
+ */
protected abstract ColorUIResource getSecondary2();
+
+ /**
+ * Returns the third secondary color for this theme.
+ *
+ * @return The third secondary color.
+ */
protected abstract ColorUIResource getSecondary3();
+ /**
+ * Returns the font used for text on controls.
+ *
+ * @return The font used for text on controls.
+ */
public abstract FontUIResource getControlTextFont();
+
+ /**
+ * Returns the font used for text in menus.
+ *
+ * @return The font used for text in menus.
+ */
public abstract FontUIResource getMenuTextFont();
+
+ /**
+ * Returns the font used for sub text.
+ *
+ * @return The font used for sub text.
+ */
public abstract FontUIResource getSubTextFont();
+
+ /**
+ * Returns the font used for system text.
+ *
+ * @return The font used for system text.
+ */
public abstract FontUIResource getSystemTextFont();
+
+ /**
+ * Returns the font used for user text.
+ *
+ * @return The font used for user text.
+ */
public abstract FontUIResource getUserTextFont();
+
+ /**
+ * Returns the font used for window titles.
+ *
+ * @return The font used for window titles.
+ */
public abstract FontUIResource getWindowTitleFont();
+
}
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: api docs for LookAndFeel, DefaultMetalTheme, MetalLookAndFeel and MetalTheme,
David Gilbert <=