All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.ui.framework.java.UIFramework

java.lang.Object
   |
   +----com.ibm.as400.ui.framework.java.UIFramework

public abstract class UIFramework
extends Object
This class keeps track of global properties for this package. UIFramework contains settings that control how the application's resources are managed, and whether the look and feel of user interface panels should be set to conform to that of the current operating system platform.

On initial startup, applications should ensure that the values set are consistent with the desired behavior for the framework.


Variable Index

 o BYPASS_CACHED_RESOURCES
Indicates that the UI framework should not use cached resource bundles.
 o CHECK_FOR_SERIALIZED
Indicates that the UI framework should check for a serialized panel definition.
 o ONLY_PARSE_XML
Indicates that the UI framework should not check for a serialized panel definition.
 o ONLY_USE_SERIALIZED
Indicates that the UI framework should only use serialized panel definitions.
 o USE_CACHED_RESOURCES
Indicates that the UI framework should use cached resource bundles.

Method Index

 o getResourceMode()
Returns the current resource mode for the UI framework.
 o getSearchMode()
Returns the current search mode for the UI framework.
 o getVersion()
Returns the version of the AS/400 Graphical Toolbox.
 o isSystemLookAndFeelEnabled()
Determines whether the UI framework will set the system look and feel for the current operating system.
 o setResourceMode(int)
Controls whether the UI framework should use cached resource bundles.
 o setSearchMode(int)
Controls where the UI framework should obtain panel definitions for panels associated with the current application.
 o setSystemLookAndFeelEnabled(boolean)
Controls whether the UI framework should attempt to set the look and feel for the current operating system platform.

Variables

 o USE_CACHED_RESOURCES
 public static final int USE_CACHED_RESOURCES
Indicates that the UI framework should use cached resource bundles. When a resource bundle is initially loaded it is added to a system cache. Subsequent requests for the resource bundle will be satisfied from this cache.

 o BYPASS_CACHED_RESOURCES
 public static final int BYPASS_CACHED_RESOURCES
Indicates that the UI framework should not use cached resource bundles. All requests for a particular resource bundle will cause the resources to be reloaded from an external source, such as a local hard drive or a location on the network.

 o ONLY_USE_SERIALIZED
 public static final int ONLY_USE_SERIALIZED
Indicates that the UI framework should only use serialized panel definitions. If a serialized definition for a panel is not found an exception will be thrown.

 o CHECK_FOR_SERIALIZED
 public static final int CHECK_FOR_SERIALIZED
Indicates that the UI framework should check for a serialized panel definition. If the serialized file is not found, the panel definition should be obtained by parsing the PDML document.

 o ONLY_PARSE_XML
 public static final int ONLY_PARSE_XML
Indicates that the UI framework should not check for a serialized panel definition. Panel definitions should always be obtained by parsing an PDML document.

Methods

 o getResourceMode
 public static int getResourceMode()
Returns the current resource mode for the UI framework.

Returns:
one of the pre-defined resource mode constants
See Also:
setResourceMode
 o setResourceMode
 public static void setResourceMode(int resourceMode)
Controls whether the UI framework should use cached resource bundles. Defaults to USE_CACHED_RESOURCES.

Parameters:
resourceMode - one of the pre-defined resource mode constants
See Also:
getResourceMode
 o getSearchMode
 public static int getSearchMode()
Returns the current search mode for the UI framework.

Returns:
one of the pre-defined search mode constants
See Also:
setSearchMode
 o setSearchMode
 public static void setSearchMode(int searchMode)
Controls where the UI framework should obtain panel definitions for panels associated with the current application. Defaults to CHECK_FOR_SERIALIZED.

Parameters:
searchMode - one of the pre-defined search mode constants
See Also:
getSearchMode
 o isSystemLookAndFeelEnabled
 public static boolean isSystemLookAndFeelEnabled()
Determines whether the UI framework will set the system look and feel for the current operating system.

Returns:
true if the system look and feel will be set; false otherwise.
See Also:
setSystemLookAndFeelEnabled
 o setSystemLookAndFeelEnabled
 public static void setSystemLookAndFeelEnabled(boolean enabled)
Controls whether the UI framework should attempt to set the look and feel for the current operating system platform. Defaults to true.

Parameters:
enabled - If true, set the system look and feel; otherwise, do nothing.
See Also:
isSystemLookAndFeelEnabled
 o getVersion
 public static int getVersion()
Returns the version of the AS/400 Graphical Toolbox.

Returns:
the Toolbox version, release and modification level as a hex integer of the form 0x00vvrrmm

All Packages  Class Hierarchy  This Package  Previous  Next  Index