com.plumtree.uiinfrastructure.pagecontrols.framework
Class JSComponentMgr

java.lang.Object
  com.plumtree.uiinfrastructure.pagecontrols.framework.ComponentMgr
      com.plumtree.uiinfrastructure.pagecontrols.framework.JSComponentMgr

Direct Known Subclasses:

JSDatePickerMgr

public class JSComponentMgr
extends ComponentMgr

This class is meant to manage JS components. Most of the work is done by the parent class. However, there are some things that are specific to the JS classes that are handled by the JS registry. For many JS components (like the date-picker), you will want to override this class.

Author:

John Osborne

Field Summary

static java.lang.String

STR_CLASS_NAME class name constant

Constructor Summary

JSComponentMgr(java.lang.String _strControlName, JSRegistry _ptJSRegistry, IJSComponentVersionMgr _ptJSCompVerMgr, PageMgr _ptPageMgr)
Creates a new JSComponentMgr object.

Method Summary

java.lang.String	GetJSControlName() Returns the name for JS controls of this type (ie.e jsdatepicker").
HTMLElementCollection	GetJSIncludes() This method returns the HTML script include tags required by JS components of this type.
int	GetVersionIDAsInt() Returns the version number of the JS component that is being used.
java.lang.String	GetVersionIDAsString() Returns the version number of the JS component that is being used.

Methods inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.ComponentMgr

AddToValidationFunction, GetAllHeadContent, GetAllPostContent, GetAllPreContent, GetAllPreFormContent, GetComponent, GetComponent, GetComponentHeadContent, GetComponentHeadContent, GetComponentHTML, GetComponentHTML, GetComponentPostContent, GetComponentPostContent, GetComponentPreContent, GetComponentPreContent, GetComponentPreFormContent, GetComponentPreFormContent, GetJSValidationCode, GetNumComponents, GetPageHeadContent, GetPageMgr, GetPagePostContent, GetPagePreContent, GetPagePreFormContent, RegisterComponent, StoreAllUserInput, StoreUserInput, StoreUserInput, UnRegisterComponent, Validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_CLASS_NAME

public static final java.lang.String STR_CLASS_NAME

class name constant

See Also:

Constant Field Values

Constructor Detail

JSComponentMgr

public JSComponentMgr(java.lang.String _strControlName,
                      JSRegistry _ptJSRegistry,
                      IJSComponentVersionMgr _ptJSCompVerMgr,
                      PageMgr _ptPageMgr)

Creates a new JSComponentMgr object.

Parameters:

_strControlName - The name for JS controls of this type (ie.e jsdatepicker").

_ptJSRegistry - The JS Registry that handles versioning for JS components.

_ptJSCompVerMgr - An object that can tell you the version number to use for a particular JS component (given a string name).

_ptPageMgr - The page manager for this component manager.

Method Detail

GetJSControlName

public java.lang.String GetJSControlName()

Returns the name for JS controls of this type (ie.e jsdatepicker").

Returns:

The name for JS controls of this type.

GetJSIncludes

public HTMLElementCollection GetJSIncludes()

This method returns the HTML script include tags required by JS components of this type. If none are found, it will return null.

Returns:

The HTML script includes.

GetVersionIDAsInt

public int GetVersionIDAsInt()

Returns the version number of the JS component that is being used.

Returns:

The version number of the JS component that is being used (as an int).

GetVersionIDAsString

public java.lang.String GetVersionIDAsString()

Returns the version number of the JS component that is being used.

Returns:

The version number of the JS component that is being used (as a String).