WebObjects 5.4.2

com.webobjects.eoapplication
Class EOUserInterfaceParameters

java.lang.Object
  extended by com.webobjects.eoapplication.EOUserInterfaceParameters

public class EOUserInterfaceParameters
extends Object

EOUserInterfaceParameters has many static methods used to localize strings and icons and to determine several aspects (fonts, colors, border sizes) of the user interface.

The methods to retrieve localized and platform-specific strings and images use a resource bundle which you can set with setStandardResourceBundle. Unless you specify your own custom resource bundle, an instance of EODefaultResourceBundle is used to load resources from the server.

EOUserInterfaceParameters also has various methods to set and get fonts, colors and border sizes which are used by controllers while they dynamically generate elements of the user interface. So you can widely modify the look of the application by invoking a few set methods on EOUserInterfaceParameters as long as you use dynamic user interface generation (Direct to Java Client).

See Also:
EOUserInterfaceParameters.standardResourceBundle(), EODefaultResourceBundle

Field Summary
static String OptimizeForMacKey
           
 
Constructor Summary
EOUserInterfaceParameters()
           
 
Method Summary
static Font actionTitleFont()
          Returns the font used for large-size action buttons.
static int actionTitlePosition()
          Returns the title position in large-size action buttons.
static boolean activateWindowsDelayed()
          Returns whether windows should be activated delayed at the end of an event.
static boolean allowActionIcons()
          Returns whether large-size action buttons should use icons or not (if icons are available).
static boolean allowSmallActionIcons()
          Returns whether small-size action buttons should use icons or not (if icons are available).
static Color disabledTextBackgroundColor()
          Returns the color used for the background of disabled text fields.
static Color editableTextBackgroundColor()
          Returns the color used for the background of editable text fields.
static boolean enableSaveOnlyIfEdited()
          Returns whether Save actions should only be enabled if a document is edited.
static Color highlightLabelColor()
          Returns the color used for highlighted labels (in front of widgets).
static Font highlightLabelFont()
          Returns the font used for highlighted labels (in front of widgets).
static Color highlightTitleColor()
          Returns the color used for highlighted titles, for example in boxes and tab views.
static Font highlightTitleFont()
          Returns the font used for highlighted titles, for example in boxes and tab views.
static Color labelColor()
          Returns the color used for labels (in front of widgets).
static int labelDistance()
          Returns the distance between labels and widgets used by the default controller layout mechanisms.
static Font labelFont()
          Returns the font used for labels (in front of widgets).
static int largeBorder()
          Returns the large border size used by the default controller layout mechanisms.
static Icon localizedIcon(String iconName)
          Returns a localized version of the icon named iconName or null if no icon can be found with the specified name.
static String localizedString(String string)
          Returns a localized version of string or string itself if no localized version can be found.
static boolean makeIconBackgroundsTransparent()
          Returns whether the background of all icons loaded through the default resource bundle should be made explicitly transparent.
static int mediumBorder()
          Returns the medium border size used by the default controller layout mechanisms.
static Dimension minimumActionButtonSize()
          Returns the minimum size of large-size action buttons.
static Dimension minimumSmallActionButtonSize()
          Returns the minimum size of small-size action buttons.
static Dimension minimumSpecialActionButtonSize()
          Returns the minimum size of special action buttons used as integration components for controllers activated by buttons.
static void optimizeForMac()
           
static boolean optimizeMenuAccelerators()
          Returns whether standard menu accelerators like Command-n (new), Command-o (open) should be constantly updated to affect the active type of document (object).
static Color queryTextBackgroundColor()
          Returns the color used for the background of query text fields.
static void setActionTitleFont(Font font)
          Sets the font used for large-size action buttons.
static void setActionTitlePosition(int position)
          Sets the title position in large-size action buttons.
static void setActivateWindowsDelayed(boolean flag)
          Sets whether windows should be activated delayed at the end of an event.
static void setAllowActionIcons(boolean flag)
          Sets whether large-size action buttons should use icons or not (if icons are available).
static void setAllowSmallActionIcons(boolean flag)
          Sets whether small-size action buttons should use icons or not (if icons are available).
static void setDisabledTextBackgroundColor(Color color)
          Sets the color used for the background of disabled text fields.
static void setEditableTextBackgroundColor(Color color)
          Sets the color used for the background of editable text fields.
static void setEnableSaveOnlyIfEdited(boolean flag)
          Sets whether Save actions should only be enabled if a document is edited.
static void setHighlightLabelColor(Color color)
          Sets the color used for highlighted labels (in front of widgets).
static void setHighlightLabelFont(Font font)
          Sets the font used for highlighted labels (in front of widgets).
static void setHighlightTitleColor(Color color)
          Sets the color used for highlighted titles, for example in boxes and tab views.
static void setHighlightTitleFont(Font font)
          Sets the font used for highlighted titles, for example in boxes and tab views.
static void setLabelColor(Color color)
          Sets the color used for labels (in front of widgets).
static void setLabelDistance(int distance)
          Sets the distance between labels and widgets used by the default controller layout mechanisms.
static void setLabelFont(Font font)
          Sets the font used for labels (in front of widgets).
static void setLargeBorder(int border)
          Sets the large border size used by the default controller layout mechanisms.
static void setMakeIconBackgroundsTransparent(boolean flag)
          Sets whether the background of all icons loaded through the default resource bundle should be made explicitly transparent.
static void setMediumBorder(int border)
          Sets the medium border size used by the default controller layout mechanisms.
static void setMinimumActionButtonSize(Dimension size)
          Sets the minimum size of large-size action buttons.
static void setMinimumSmallActionButtonSize(Dimension size)
          Sets the minimum size of small-size action buttons.
static void setMinimumSpecialActionButtonSize(Dimension size)
          Sets the minimum size of small-size of special action buttons used as integration components for controllers activated by buttons.
static void setOptimizeMenuAccelerators(boolean flag)
          Sets whether standard menu accelerators like Command-n (new), Command-o (open) should be constantly updated to affect the active type of document (object).
static void setQueryTextBackgroundColor(Color color)
          Sets the color used for the background of query text fields.
static void setShowDefaultDocumentActionsInWindows(boolean flag)
          Sets whether the default document actions like Save and Revert should be shown with explicit buttons in document windows.
static void setSmallActionTitleFont(Font font)
          Sets the font used for small-size action buttons.
static void setSmallActionTitlePosition(int position)
          Sets the title position in small-size action buttons.
static void setSmallBorder(int border)
          Sets the small border size used by the default controller layout mechanisms.
static void setSpecialActionTitleFont(Font font)
          Sets the font used for special action buttons with icons.
static void setSpecialActionTitlePosition(int position)
          Sets the title position in the special action buttons used as integration components for controllers activated by buttons.
static void setSpecialTextOnlyActionTitleFont(Font font)
          Sets the font used for special action buttons without icons (text only).
static void setStandardResourceBundle(ResourceBundle resourceBundle)
          Sets the resource bundle used by the methods on EOUserInterfaceParameters to retrieve localized and platform specific resources.
static void setTitleColor(Color color)
          Sets the color used for titles, for example in boxes and tab views.
static void setTitleFont(Font font)
          Sets the font used for titles, for example in boxes and tab views.
static void setUseBorderWithActionIcons(boolean flag)
          Sets whether large-size action buttons with icons use borders or not.
static void setUseBorderWithSmallActionIcons(boolean flag)
          Sets whether small-size action buttons with icons use borders or not.
static void setUseSpecialColors(boolean flag)
          Sets whether widgets generated dynamically by controllers use the colors specified in EOUserInterfaceParameters or not.
static void setUseSpecialFonts(boolean flag)
          Sets whether widgets generated dynamically by controllers use the fonts specified in EOUserInterfaceParameters or not.
static void setUseTitleWithActionIcons(boolean flag)
          Sets whether large-size action buttons with icons also display titles or not.
static void setUseTitleWithSmallActionIcons(boolean flag)
          Sets whether small-size action buttons with icons also display titles or not.
static void setUseWindowMenus(boolean flag)
          Sets whether all windows (frames) of the application should show the standard application actions menu.
static void setWidgetFont(Font font)
          Sets the font used for normal input widgets, for example text fields.
static boolean showDefaultDocumentActionsInWindows()
          Returns whether the default document actions like Save and Revert should be shown with explicit buttons in document windows.
static Font smallActionTitleFont()
          Returns the font used for small-size action buttons.
static int smallActionTitlePosition()
          Returns the title position in small-size action buttons.
static int smallBorder()
          Returns the small border size used by the default controller layout mechanisms.
static Font specialActionTitleFont()
          Returns the font used for special action buttons with icons.
static int specialActionTitlePosition()
          Returns the title position in the special action buttons used as integration components for controllers activated by buttons.
static Font specialTextOnlyActionTitleFont()
          Returns the font used for special action buttons without icons (text only).
static Icon standardActionIcon(String actionName)
          Returns a localized version of a large-size icon representing the action actionName (for example "save") or null if no icon for the action can be found.
static ResourceBundle standardResourceBundle()
          Returns the resource bundle used by the methods on EOUserInterfaceParameters to retrieve localized and platform specific resources.
static Icon standardSmallActionIcon(String actionName)
          Returns a localized version of a small-size icon representing the action actionName (for example "save") or null if no icon for the action can be found.
static Color titleColor()
          Returns the color used for titles, for example in boxes and tab views.
static Font titleFont()
          Returns the font used for titles, for example in boxes and tab views.
static boolean useBorderWithActionIcons()
          Returns whether large-size action buttons with icons use borders or not.
static boolean useBorderWithSmallActionIcons()
          Returns whether small-size action buttons with icons use borders or not.
static boolean useSpecialColors()
          Returns whether widgets generated dynamically by controllers use the colors specified in EOUserInterfaceParameters or not.
static boolean useSpecialFonts()
          Returns whether widgets generated dynamically by controllers use the fonts specified in EOUserInterfaceParameters or not.
static boolean useTitleWithActionIcons()
          Returns whether large-size action buttons with icons also display titles or not.
static boolean useTitleWithSmallActionIcons()
          Returns whether small-size action buttons with icons also display titles or not.
static boolean useWindowMenus()
          Returns whether all windows (frames) of the application should show the standard application actions menu.
static Font widgetFont()
          Returns the font used for normal input widgets, for example text fields.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OptimizeForMacKey

public static final String OptimizeForMacKey
See Also:
Constant Field Values
Constructor Detail

EOUserInterfaceParameters

public EOUserInterfaceParameters()
Method Detail

optimizeForMac

public static void optimizeForMac()

setActivateWindowsDelayed

public static void setActivateWindowsDelayed(boolean flag)
Sets whether windows should be activated delayed at the end of an event. Activating windows delayed prevents the window size from changing visibly for the user in case the window content is layed out dynamically and has to grow multiple times while building up all widgets during an event. The default is true.

Parameters:
flag - true if windows should be activated delayed at the end of an event; false otherwise

activateWindowsDelayed

public static boolean activateWindowsDelayed()
Returns whether windows should be activated delayed at the end of an event. Activating windows delayed prevents the window size from changing visibly for the user in case the window content is layed out dynamically and has to grow multiple times while building up all widgets during an event. The default is true.

Returns:
true if windows should be activated delayed at the end of an event; false otherwise

setUseWindowMenus

public static void setUseWindowMenus(boolean flag)
Sets whether all windows (frames) of the application should show the standard application actions menu. The default is true.

Parameters:
flag - true if all frames should show the standard application actions menu; false otherwise

useWindowMenus

public static boolean useWindowMenus()
Returns whether all windows (frames) of the application should show the standard application actions menu. The default is true.

Returns:
true if all frames should show the standard application actions menu; false otherwise

setOptimizeMenuAccelerators

public static void setOptimizeMenuAccelerators(boolean flag)
Sets whether standard menu accelerators like Command-n (new), Command-o (open) should be constantly updated to affect the active type of document (object). The default is true.

Parameters:
flag - true if standard menu accelerators should be updated based on the active type of document; false otherwise

optimizeMenuAccelerators

public static boolean optimizeMenuAccelerators()
Returns whether standard menu accelerators like Command-n (new), Command-o (open) should be constantly updated to affect the active type of document (object). The default is true.

Returns:
flag true if standard menu accelerators should be updated based on the active type of document; false otherwise.

setShowDefaultDocumentActionsInWindows

public static void setShowDefaultDocumentActionsInWindows(boolean flag)
Sets whether the default document actions like Save and Revert should be shown with explicit buttons in document windows. The default is true.

Parameters:
flag - true if the default document actions should be shown with explicit buttons in document windows; false otherwise

showDefaultDocumentActionsInWindows

public static boolean showDefaultDocumentActionsInWindows()
Returns whether the default document actions like Save and Revert should be shown with explicit buttons in document windows. The default is true.

Returns:
flag true if the default document actions should be shown with explicit buttons in document windows; false otherwise

setEnableSaveOnlyIfEdited

public static void setEnableSaveOnlyIfEdited(boolean flag)
Sets whether Save actions should only be enabled if a document is edited. The default is true.

Parameters:
flag - true if Save actions should only be enabled if a document is edited; false otherwise

enableSaveOnlyIfEdited

public static boolean enableSaveOnlyIfEdited()
Returns whether Save actions should only be enabled if a document is edited. The default is true.

Returns:
flag true if Save actions should only be enabled if a document is edited; false otherwise

setAllowActionIcons

public static void setAllowActionIcons(boolean flag)
Sets whether large-size action buttons should use icons or not (if icons are available). The default is true.

Parameters:
flag - true if large-size action buttons should use icons; false otherwise

allowActionIcons

public static boolean allowActionIcons()
Returns whether large-size action buttons should use icons or not (if icons are available). The default is true.

Returns:
true if large-size action buttons should use icons; false otherwise

setAllowSmallActionIcons

public static void setAllowSmallActionIcons(boolean flag)
Sets whether small-size action buttons should use icons or not (if icons are available).

Parameters:
flag - true if small-size action buttons should use icons; false otherwise

allowSmallActionIcons

public static boolean allowSmallActionIcons()
Returns whether small-size action buttons should use icons or not (if icons are available). The default is true.

Returns:
true if small-size action buttons should use icons; false otherwise

setMakeIconBackgroundsTransparent

public static void setMakeIconBackgroundsTransparent(boolean flag)
Sets whether the background of all icons loaded through the default resource bundle should be made explicitly transparent. This option is useful if you load your own icons whithout transparent background. The assumption is that the pixel in the top-left corner of the icons determines the background color. The default is false.

Parameters:
flag - true if icon backgrounds should be made explicitly transparent; false otherwise

makeIconBackgroundsTransparent

public static boolean makeIconBackgroundsTransparent()
Returns whether the background of all icons loaded through the default resource bundle should be made explicitly transparent. This option is useful if you load your own icons whithout transparent background. The assumption is that the pixel in the top-left corner of the icons determines the background color. The default is false.

Returns:
true if icon backgrounds should be made explicitly transparent; false otherwise

setUseBorderWithActionIcons

public static void setUseBorderWithActionIcons(boolean flag)
Sets whether large-size action buttons with icons use borders or not. The default is false on Mac OS X and true on all other platforms.

Parameters:
flag - true if large-size action buttons with icons use borders; false otherwise

useBorderWithActionIcons

public static boolean useBorderWithActionIcons()
Returns whether large-size action buttons with icons use borders or not. The default is false on Mac OS X and true on all other platforms.

Returns:
true if large-size action buttons with icons use borders; false otherwise

setUseBorderWithSmallActionIcons

public static void setUseBorderWithSmallActionIcons(boolean flag)
Sets whether small-size action buttons with icons use borders or not. The default is false on Mac OS X and true on all other platforms.

Parameters:
flag - true if small-size action buttons with icons use borders; false otherwise

useBorderWithSmallActionIcons

public static boolean useBorderWithSmallActionIcons()
Returns whether small-size action buttons with icons use borders or not. The default is false on Mac OS X and true on all other platforms.

Returns:
true if small-size action buttons with icons use borders; false otherwise

setUseTitleWithActionIcons

public static void setUseTitleWithActionIcons(boolean flag)
Sets whether large-size action buttons with icons also display titles or not. The default is true.

Parameters:
flag - true if large-size action buttons with icons also display titles; false otherwise

useTitleWithActionIcons

public static boolean useTitleWithActionIcons()
Returns whether large-size action buttons with icons also display titles or not. The default is true.

Returns:
true if large-size action buttons with icons also display titles; false otherwise

setUseTitleWithSmallActionIcons

public static void setUseTitleWithSmallActionIcons(boolean flag)
Sets whether small-size action buttons with icons also display titles or not. The default is true.

Parameters:
flag - true if small-size action buttons with icons also display titles; false otherwise

useTitleWithSmallActionIcons

public static boolean useTitleWithSmallActionIcons()
Returns whether small-size action buttons with icons also display titles or not. The default is true.

Returns:
true if small-size action buttons with icons also display titles; false otherwise

setActionTitlePosition

public static void setActionTitlePosition(int position)
Sets the title position in large-size action buttons. The default is EOComponentController.Bottom.

Parameters:
position - the position of titles in large-size action buttons

actionTitlePosition

public static int actionTitlePosition()
Returns the title position in large-size action buttons. The default is EOComponentController.Bottom.

Returns:
the position of titles in large-size action buttons

setSmallActionTitlePosition

public static void setSmallActionTitlePosition(int position)
Sets the title position in small-size action buttons. The default is EOComponentController.Right.

Parameters:
position - the position of titles in small-size action buttons

smallActionTitlePosition

public static int smallActionTitlePosition()
Returns the title position in small-size action buttons. The default is EOComponentController.Right.

Returns:
the position of titles in small-size action buttons

setSpecialActionTitlePosition

public static void setSpecialActionTitlePosition(int position)
Sets the title position in the special action buttons used as integration components for controllers activated by buttons. The default is EOComponentController.Right.

Parameters:
position - the position of titles in special action buttons

specialActionTitlePosition

public static int specialActionTitlePosition()
Returns the title position in the special action buttons used as integration components for controllers activated by buttons. The default is EOComponentController.Right.

Returns:
the position of titles in special action buttons.

setMinimumActionButtonSize

public static void setMinimumActionButtonSize(Dimension size)
Sets the minimum size of large-size action buttons. The default is 32 x 48.

Parameters:
size - the minimum size of large-size action buttons

minimumActionButtonSize

public static Dimension minimumActionButtonSize()
Returns the minimum size of large-size action buttons. The default is 32 x 48.

Returns:
the minimum size of large-size action buttons

setMinimumSmallActionButtonSize

public static void setMinimumSmallActionButtonSize(Dimension size)
Sets the minimum size of small-size action buttons. The default is 60 x 12.

Parameters:
size - the minimum size of small-size action buttons

minimumSmallActionButtonSize

public static Dimension minimumSmallActionButtonSize()
Returns the minimum size of small-size action buttons. The default is 60 x 12.

Returns:
the minimum size of small-size action buttons

setMinimumSpecialActionButtonSize

public static void setMinimumSpecialActionButtonSize(Dimension size)
Sets the minimum size of small-size of special action buttons used as integration components for controllers activated by buttons. The default is 60 x 16.

Parameters:
size - the minimum size of special action buttons

minimumSpecialActionButtonSize

public static Dimension minimumSpecialActionButtonSize()
Returns the minimum size of special action buttons used as integration components for controllers activated by buttons. The default is 60 x 16.

Returns:
the minimum size of special action buttons

setSmallBorder

public static void setSmallBorder(int border)
Sets the small border size used by the default controller layout mechanisms. The default is 1.

Parameters:
border - the small border size used by the default controller layout mechanisms

smallBorder

public static int smallBorder()
Returns the small border size used by the default controller layout mechanisms. The default is 1.

Returns:
the small border size used by the default controller layout mechanisms

setMediumBorder

public static void setMediumBorder(int border)
Sets the medium border size used by the default controller layout mechanisms. The default is 2.

Parameters:
border - the medium border size used by the default controller layout mechanisms

mediumBorder

public static int mediumBorder()
Returns the medium border size used by the default controller layout mechanisms. The default is 2.

Returns:
the medium border size used by the default controller layout mechanisms

setLargeBorder

public static void setLargeBorder(int border)
Sets the large border size used by the default controller layout mechanisms. The default is 6.

Parameters:
border - the large border size used by the default controller layout mechanisms

largeBorder

public static int largeBorder()
Returns the large border size used by the default controller layout mechanisms. The default is 6.

Returns:
the large border size used by the default controller layout mechanisms

setLabelDistance

public static void setLabelDistance(int distance)
Sets the distance between labels and widgets used by the default controller layout mechanisms. The default is 1.

Parameters:
distance - the distance between labels and widgets used by the default controller layout mechanisms

labelDistance

public static int labelDistance()
Returns the distance between labels and widgets used by the default controller layout mechanisms. The default is 1.

Returns:
the distance between labels and widgets used by the default controller layout mechanisms

setUseSpecialFonts

public static void setUseSpecialFonts(boolean flag)
Sets whether widgets generated dynamically by controllers use the fonts specified in EOUserInterfaceParameters or not. If not, widgets simply use the default fonts. By using the fonts specified in EOUserInterfaceParameters, application user interfaces look more consistent and you can change the look of the complete application with one single set method. The default is false, but the EODynamicApplication class used for Direct to Java Client sets it to true at startup time.

Parameters:
flag - true if dynamically generated widgets should use the fonts specified in EOUserInterfaceParameters; false otherwise

useSpecialFonts

public static boolean useSpecialFonts()
Returns whether widgets generated dynamically by controllers use the fonts specified in EOUserInterfaceParameters or not. If not, widgets simply use the default fonts. By using the fonts specified in EOUserInterfaceParameters, application user interfaces look more consistent and you can change the look of the complete application with one single set method. The default is false, but the EODynamicApplication class used for Direct to Java Client sets it to true at startup time.

Returns:
true if dynamically generated widgets should use the fonts specified in EOUserInterfaceParameters; false otherwise

setWidgetFont

public static void setWidgetFont(Font font)
Sets the font used for normal input widgets, for example text fields.

Parameters:
font - the font used for normal input widgets

widgetFont

public static Font widgetFont()
Returns the font used for normal input widgets, for example text fields.

Returns:
the font used for normal input widgets

setLabelFont

public static void setLabelFont(Font font)
Sets the font used for labels (in front of widgets).

Parameters:
font - the font used for labels

labelFont

public static Font labelFont()
Returns the font used for labels (in front of widgets).

Returns:
the font used for labels

setHighlightLabelFont

public static void setHighlightLabelFont(Font font)
Sets the font used for highlighted labels (in front of widgets).

Parameters:
font - the font used for highlighted labels

highlightLabelFont

public static Font highlightLabelFont()
Returns the font used for highlighted labels (in front of widgets).

Returns:
the font used for highlighted labels

setTitleFont

public static void setTitleFont(Font font)
Sets the font used for titles, for example in boxes and tab views.

Parameters:
font - the font used for titles

titleFont

public static Font titleFont()
Returns the font used for titles, for example in boxes and tab views.

Returns:
the font used for titles

setHighlightTitleFont

public static void setHighlightTitleFont(Font font)
Sets the font used for highlighted titles, for example in boxes and tab views.

Parameters:
font - the font used for highlighted titles

highlightTitleFont

public static Font highlightTitleFont()
Returns the font used for highlighted titles, for example in boxes and tab views.

Returns:
the font used for highlighted titles

setActionTitleFont

public static void setActionTitleFont(Font font)
Sets the font used for large-size action buttons.

Parameters:
font - the font used for large-size action buttons

actionTitleFont

public static Font actionTitleFont()
Returns the font used for large-size action buttons.

Returns:
the font used for large-size action buttons

setSmallActionTitleFont

public static void setSmallActionTitleFont(Font font)
Sets the font used for small-size action buttons.

Parameters:
font - the font used for small-size action buttons

smallActionTitleFont

public static Font smallActionTitleFont()
Returns the font used for small-size action buttons.

Returns:
the font used for small-size action buttons

setSpecialActionTitleFont

public static void setSpecialActionTitleFont(Font font)
Sets the font used for special action buttons with icons.

Parameters:
font - the font used for special action buttons with icons

specialActionTitleFont

public static Font specialActionTitleFont()
Returns the font used for special action buttons with icons.

Returns:
the font used for special action buttons with icons

setSpecialTextOnlyActionTitleFont

public static void setSpecialTextOnlyActionTitleFont(Font font)
Sets the font used for special action buttons without icons (text only).

Parameters:
font - the font used for special action buttons without icons

specialTextOnlyActionTitleFont

public static Font specialTextOnlyActionTitleFont()
Returns the font used for special action buttons without icons (text only).

Returns:
the font used for special action buttons without icons

setUseSpecialColors

public static void setUseSpecialColors(boolean flag)
Sets whether widgets generated dynamically by controllers use the colors specified in EOUserInterfaceParameters or not. If not, widgets simply use the default colors. By using the colors specified in EOUserInterfaceParameters, application user interfaces look more consistent and you can change the look of the complete application with one single set method. The default is false, but the EODynamicApplication class used for Direct to Java Client sets it to true at startup time.

Parameters:
flag - true if dynamically generated widgets should use the colors specified in EOUserInterfaceParameters; false otherwise

useSpecialColors

public static boolean useSpecialColors()
Returns whether widgets generated dynamically by controllers use the colors specified in EOUserInterfaceParameters or not. If not, widgets simply use the default colors. By using the colors specified in EOUserInterfaceParameters, application user interfaces look more consistent and you can change the look of the complete application with one single set method. The default is false, but the EODynamicApplication class used for Direct to Java Client sets it to true at startup time.

Returns:
true if dynamically generated widgets should use the colors specified in EOUserInterfaceParameters; false otherwise

setEditableTextBackgroundColor

public static void setEditableTextBackgroundColor(Color color)
Sets the color used for the background of editable text fields. Also updates the default background color used by EOTextAssociations unless it has been set explicitly before.

Parameters:
color - the color used for the background of editable text fields

editableTextBackgroundColor

public static Color editableTextBackgroundColor()
Returns the color used for the background of editable text fields.

Returns:
the color used for the background of editable text fields

setDisabledTextBackgroundColor

public static void setDisabledTextBackgroundColor(Color color)
Sets the color used for the background of disabled text fields. Also updates the default background color used by EOTextAssociations unless it has been set explicitly before.

Parameters:
color - the color used for the background of disabled text fields

disabledTextBackgroundColor

public static Color disabledTextBackgroundColor()
Returns the color used for the background of disabled text fields.

Returns:
the color used for the background of disabled text fields

setQueryTextBackgroundColor

public static void setQueryTextBackgroundColor(Color color)
Sets the color used for the background of query text fields.

Parameters:
color - the color used for the background of query text fields

queryTextBackgroundColor

public static Color queryTextBackgroundColor()
Returns the color used for the background of query text fields.

Returns:
the color used for the background of query text fields

setLabelColor

public static void setLabelColor(Color color)
Sets the color used for labels (in front of widgets).

Parameters:
color - the color used for labels

labelColor

public static Color labelColor()
Returns the color used for labels (in front of widgets).

Returns:
the color used for labels

setHighlightLabelColor

public static void setHighlightLabelColor(Color color)
Sets the color used for highlighted labels (in front of widgets).

Parameters:
color - the color used for highlighted labels

highlightLabelColor

public static Color highlightLabelColor()
Returns the color used for highlighted labels (in front of widgets).

Returns:
the color used for highlighted labels

setTitleColor

public static void setTitleColor(Color color)
Sets the color used for titles, for example in boxes and tab views.

Parameters:
color - the color used for titles

titleColor

public static Color titleColor()
Returns the color used for titles, for example in boxes and tab views.

Returns:
the color used for titles

setHighlightTitleColor

public static void setHighlightTitleColor(Color color)
Sets the color used for highlighted titles, for example in boxes and tab views.

Parameters:
color - the color used for highlighted titles

highlightTitleColor

public static Color highlightTitleColor()
Returns the color used for highlighted titles, for example in boxes and tab views.

Returns:
the color used for highlighted titles

setStandardResourceBundle

public static void setStandardResourceBundle(ResourceBundle resourceBundle)
Sets the resource bundle used by the methods on EOUserInterfaceParameters to retrieve localized and platform specific resources. The default is an instance of EODefautResourceBundle.

Parameters:
resourceBundle - the resource bundle used to retrieve localized and platform specific resources

standardResourceBundle

public static ResourceBundle standardResourceBundle()
Returns the resource bundle used by the methods on EOUserInterfaceParameters to retrieve localized and platform specific resources. The default is an instance of EODefautResourceBundle.

Returns:
the resource bundle used to retrieve localized and platform specific resources

localizedString

public static String localizedString(String string)
Returns a localized version of string or string itself if no localized version can be found.

Parameters:
string - the string to localize
Returns:
the localized string

localizedIcon

public static Icon localizedIcon(String iconName)
Returns a localized version of the icon named iconName or null if no icon can be found with the specified name.

Parameters:
iconName - the name of the localized icon to load
Returns:
the icon or null if no icon can be found with the specified name

standardActionIcon

public static Icon standardActionIcon(String actionName)
Returns a localized version of a large-size icon representing the action actionName (for example "save") or null if no icon for the action can be found. The name of the icon looked up is derived from the action name as "ActionIcon", (for example "ActionIconSave").

Parameters:
actionName - the name of the action
Returns:
the icon or null if no icon can be found for the action

standardSmallActionIcon

public static Icon standardSmallActionIcon(String actionName)
Returns a localized version of a small-size icon representing the action actionName (for example "save") or null if no icon for the action can be found. The name of the icon looked up is derived from the action name as "SmallActionIcon", (for example "SmallActionIconSave").

Parameters:
actionName - the name of the action
Returns:
the icon or null if no icon can be found for the action

Last updated June 2008

Copyright © 2000-2008 Apple Inc.