Package org.scopemvc.util

Utility classes that include two main areas of interest to application developers: ScopeConfig for configuring the Scope framework, and UIStrings used to look up user-readable Strings from localised resources.

See:
Description

Interface Summary

ObjectPool	Pool of objects
PoolableObjectFactory	Interface for creating poolable objects.

Class Summary

BasicObjectPool	Pools objects given a factory and optional maximum pool size.
BasicPoolableObjectFactory	Creates pooleable instances of a specific class.
DateTime	An empty marker subclass of java.util.Date that DateTimeStringConvertor is associated with in the default configuration.
Debug	A (very simple) general purpose Debug class for assertion checking.
DefaultScopeConfig	Default resources for Scope.
KeyValue	Holds two Objects: a key and a value.
ObjectPoolManager	Manages pooling of instances of different classes.
ResourceLoader	Utility class for loading resources.
ScopeConfig	Loads the Scope config in such a way that custom properties can be set from the Java command line (-D switch) or from a custom ResourceBundle.
Time	An empty marker subclass of java.util.Date that TimeStringConvertor is associated with in the default configuration.
UIStrings	Uses a ResourceBundle as a dictionary mapping IDs against user-readable Strings that can be presented on the UI.
WeakSet	Holds a set of objects where the fact that the object is contained within the set does not prevent it from being garbage collected.

Exception Summary

LocalizedException

An Exception that implements LocalizedException.getLocalizedMessage() by looking up its message as an ID that is looked up in UIStrings to present the user with a localised message: message parameters passed in are substituted in the message as java.text.MessageFormat.

Package org.scopemvc.util Description

Utility classes that include two main areas of interest to application developers: ScopeConfig for configuring the Scope framework, and UIStrings used to look up user-readable Strings from localised resources.

ScopeConfig

ScopeConfig is the configuration manager used to configure various aspects of Scope. Default configuration is provided by the DefaultScopeConfig ResourceBundle.

Scope can be configured by supplying an application-specific ResourceBundle and calling setPropertiesName during application startup. Any properties defined in a custom config in this way will override the defaults.

Scope configuration includes the following:

• org.scopemvc.controller.swing.SwingContext.window_icon defines the image resource used as the icon for JDialogs and JFrames. Default: /org/scopemvc/images/window_icon.gif
• org.scopemvc.controller.swing.SwingContext.progress_start_delay defines the milliseconds delay before ViewContext.startBusy() is called (ie delay before busy cursor shows in Swing if a Controller takes a long time to handle a Control). Default: 500
• List of StringConvertor.{datatype} defines the StringConvertor classes used to convert datatypes to and from their String representation. Defaults: the convertors in for all basic Java datatypes.
• org.scopemvc.util.convertor.DateStringConvertor.formatter defines either a DateFormat or a String used to create a SimpleDateFormat that will be used by DateStringConvertors to format Dates.
• List of org.scopemvc.util.convertor.DateStringConvertor.formatter.{number} defines the DateFormat objects used to parse Dates. If Strings are supplied in the config they are used to create SimpleDateFormats. The list of keys must be suffixed with sequential integers from 0 to n.
• org.scopemvc.util.convertor.TimeStringConvertor.formatter defines either a DateFormat or a String used to create a SimpleDateFormat that will be used by TimeStringConvertors to format Times.
• List of org.scopemvc.util.convertor.TimeStringConvertor.formatter.{number} defines the DateFormat objects used to parse Times. If Strings are supplied in the config they are used to create SimpleDateFormats. The list of keys must be suffixed with sequential integers from 0 to n.
• org.scopemvc.util.convertor.DateTimeStringConvertor.formatter defines either a DateFormat or a String used to create a SimpleDateFormat that will be used by DateTimeStringConvertors to format DateTimes.
• List of org.scopemvc.util.convertor.DateTimeStringConvertor.formatter.{number} defines the DateFormat objects used to parse DateTimes. If Strings are supplied in the config they are used to create SimpleDateFormats. The list of keys must be suffixed with sequential integers from 0 to n.
• List of PropertyViewer.{viewtype}-{datatype} defines the Views that BeansEditorManager returns to view specific datatypes. Defaults: viewers from org.scopemvc.view.swing for basic Java datatypes for the Swing viewtype.
• List of PropertyEditor.{viewtype}-{datatype} defines the Views that BeansEditorManager returns to edit specific datatypes. Defaults: editors from org.scopemvc.view.swing for basic Java datatypes for the Swing viewtype.
• PropertyManager defines the concrete PropertyManager implementation returned from PropertyManager#getInstance. Default: BeansPropertyManager.
• ActionManager defines the concrete ActionManager implementation returned from ActionManager#getInstance. Default: BeansActionManager.
• EditorManager defines the concrete EditorManager implementation returned from EditorManager#getInstance. Default: BeansEditorManager.
• org.scopemvc.controller.servlet.ScopeServlet.ControlParam defines the HTTP parameter used to specify ControlID in an incoming request to ScopeServlet. Default: action
• org.scopemvc.controller.servlet.ScopeServlet.ViewIDParam defines the HTTP parameter used to specify ViewID in an incoming request to ScopeServlet. Default: view
• ServletFormParameter.propertyIDPrefix defines the prefix used to identify HTTP parameters that ScopeServlet will use to repopulate a ServletView's bound model.
• ServletFormParameter.viewIDSuffix defines the separator between viewID and propertyID in an HTTP parameter used to repopulate a ServletView's bound model.
• org.scopemvc.view.servlet.xml.AbstractServletXSLView.shouldCacheTemplates determines whether org.scopemvc.view.servlet.xml.AbstractServletXSLView caches compiled XSLTs. "1" means templates are cached. "0" means templates are not cached: useful during development when XSLT edits need to be seen immediately without restarting the web application. Default: 1 (templates are cached)
• org.scopemvc.view.servlet.xml.AbstractServletXSLView.debugXMLDirectory determines whether org.scopemvc.view.servlet.xml.AbstractServletXSLView writes the XML produced from a bound model as a file. If "" then XML is not written to the filesystem, else a file is written every time a view is shown. The XML is put into the directory specified by this config. Default: ""

{ "org.scopemvc.view.servlet.xml.ServletXSLView.ModelElement", "data" }, { "org.scopemvc.view.servlet.xml.ServletXSLView.ElementElement", "element" }, { "org.scopemvc.view.servlet.xml.ServletXSLView.IDAttribute", "id" }, { "org.scopemvc.view.servlet.xml.ServletXSLView.IndexElement", "index" }, { "org.scopemvc.controller.servlet.ScopeServlet.maxControllerPoolSize", new Integer(10) },

UIStrings

A dictionary that uses localised ResourceBundle(s) to look up user-readable Strings by a key. This is used by the default ControlException handler in BasicController treating the message in the exception as a key to look up a localised String from UIStrings.

The property resource used for an application must be set up by calling UIStrings.setPropertiesName(java.lang.String) at application startup. The usual ResourceBundle localisation applies to the resource specified.