com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLNameDescLang

java.lang.Object
  com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
      com.plumtree.uiinfrastructure.pagecontrols.framework.AHTMLComponent
          com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols.HTMLNameDescLang

All Implemented Interfaces:

IManagedObject, IMVCObject, IPageControl

public class HTMLNameDescLang
extends AHTMLComponent
implements IPageControl

HTMLNameDescLang page control handles display and values of a page control made up of a text box text area and a select dropdown. The select is populated with default language options. This is a common construct throughout the admin ui.

Author:

CaiusV

Field Summary

HTMLSelectDropDown	m_SelectDropDown the selectdropdown for this object
HTMLTextArea	m_TextArea the textarea for this object
HTMLTextBox	m_TextBox the textbox for this object
static java.lang.String	STR_MVC_CLASS_NAME class name constant

Fields inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent

m_ptPageMgr

Constructor Summary

HTMLNameDescLang()
Default constructor.

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
HTMLElementCollection	GetComponentHTML() Returns the HTML for this component.
IPTGrowableSortedArrayWrapperRO	GetData() Returns member variable m_ptGSArrayWrapper.
protected java.lang.String	GetHTMLComponentBaseName() Returns the base name of this HTML Component.
java.lang.String	GetHTMLComponentValue() Return the component values of the TextBox and SelectDropdown separated by a space.
java.lang.String	GetJSValidationCode() Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID, XPResourceManager _ptResourceManager, java.lang.String _strPrimaryLang) Initializes a new HTMLNameDescLang object.
void	SetData(IPTGrowableSortedArrayWrapperRO data) Sets the member variable m_ptGSArrayWrapper
void	SetLangChoices(XPResourceManager _ptResourceManager) Set the options of the member variable m_SelectDropDown with the appropriate languages.
void	SetPrimaryLanguage(java.lang.String _sPrimaryLang) Set the primary language member variable.
XPArrayList	Validate() For every Validator associated with this object execute it's Validate method.

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

AddValidator, GetComponentMgr, GetComponentMgrName, GetHTMLComponentName, GetHTMLComponentSize, GetHTMLComponentStyleClass, GetLabel, GetValidators, Init, SetHTMLComponentName, SetHTMLComponentSize, SetHTMLComponentStyleClass, SetHTMLComponentValue, SetLabel, SetParameters, StoreUserInput

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

AppendUniqueIDToElementName, GetComponentHeadContent, GetComponentPostContent, GetComponentPreContent, GetComponentPreFormContent, GetPageMgr, GetSubComponentHTMLByIndex, GetUniqueInstanceID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IPageControl

GetComponentMgr, GetComponentMgrName, GetUniqueInstanceID, StoreUserInput

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

class name constant

See Also:

Constant Field Values

m_TextBox

public HTMLTextBox m_TextBox

the textbox for this object

m_SelectDropDown

public HTMLSelectDropDown m_SelectDropDown

the selectdropdown for this object

m_TextArea

public HTMLTextArea m_TextArea

the textarea for this object

Constructor Detail

HTMLNameDescLang

public HTMLNameDescLang()

Default constructor. Creates a new HTMLTextAndDropDown object.

Method Detail

Init

public void Init(PageMgr _ptPageMgr,
                 java.lang.String _strUniqueInstanceID,
                 XPResourceManager _ptResourceManager,
                 java.lang.String _strPrimaryLang)

Initializes a new HTMLNameDescLang object. Creates and initializes the HTMLTextBox, HTMLTextArea and HTMLSelectDropdown objects contained by this object. Populates the default languages for the select.

Parameters:

_ptPageMgr - The component manager for this component

_strUniqueInstanceID - The unique ID for this component.

_arrDropDownValueText - The dropdown values

GetHTMLComponentBaseName

protected java.lang.String GetHTMLComponentBaseName()

Returns the base name of this HTML Component.

Specified by:

GetHTMLComponentBaseName in class AHTMLComponent

Returns:

String

GetComponentHTML

public HTMLElementCollection GetComponentHTML()

Returns the HTML for this component.

Specified by:

GetComponentHTML in interface IPageControl

Specified by:

GetComponentHTML in class AComponent

Returns:

HTML for this object

GetHTMLComponentValue

public java.lang.String GetHTMLComponentValue()

Return the component values of the TextBox and SelectDropdown separated by a space.

Overrides:

GetHTMLComponentValue in class AHTMLComponent

Returns:

String

Create

public java.lang.Object Create()

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AComponent

Returns:

A new instance of the managed class (i.e. return new Foo();)

GetName

public java.lang.String GetName()

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AComponent

Returns:

the name of the object.

Validate

public XPArrayList Validate()

For every Validator associated with this object execute it's Validate method. Return an Arraylist of UIError objects generated from executing the Validators. Return and empty Arraylist if no problems were found.

Overrides:

Validate in class AHTMLComponent

Returns:

Arraylist of UIErrors.

GetJSValidationCode

public java.lang.String GetJSValidationCode()

Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.

Overrides:

GetJSValidationCode in class AHTMLComponent

Returns:

JavaScript validation code

SetLangChoices

public void SetLangChoices(XPResourceManager _ptResourceManager)

Set the options of the member variable m_SelectDropDown with the appropriate languages.

Parameters:

_ptResourceManager - XPResourceManager with language options

GetData

public IPTGrowableSortedArrayWrapperRO GetData()

Returns member variable m_ptGSArrayWrapper.

Returns:

m_ptGSArrayWrapper member variable

SetData

public void SetData(IPTGrowableSortedArrayWrapperRO data)

Sets the member variable m_ptGSArrayWrapper

Parameters:

data -

SetPrimaryLanguage

public void SetPrimaryLanguage(java.lang.String _sPrimaryLang)

Set the primary language member variable.

Parameters:

_sPrimaryLang - the primary language