com.esri.gpt.catalog.schema
Class InputSelectManyCheckbox

java.lang.Object
  com.esri.gpt.catalog.schema.Component
      com.esri.gpt.catalog.schema.UiComponent
          com.esri.gpt.catalog.schema.Input
              com.esri.gpt.catalog.schema.InputSelectManyCheckbox

public class InputSelectManyCheckbox
extends Input

Select many checkbox input component associated with a metadata parameter.

The checkbox choices are based upon the codes defined for the parameter.

The component is configured from a node with a schema configuration XML document.

Example:

<parameter key="topics">
<input type="selectManyCheckbox"/>
<codes>
<code key="boundaries" resourceKey="catalog.mdCode.topic.boundaries"/>
<code key="farming" resourceKey="catalog.mdCode.topic.farming"/>
</codes>
</parameter>

Field Summary

Fields inherited from class com.esri.gpt.catalog.schema.Input

INPUTTYPE_DELIMITEDTEXTAREA, INPUTTYPE_MAP, INPUTTYPE_SELECTMANYCHECKBOX, INPUTTYPE_SELECTONEMEMU, INPUTTYPE_SELECTWITHOTHER, INPUTTYPE_TEXT, INPUTTYPE_TEXTAREA, INPUTTYPE_TEXTARRAY, INPUTTYPE_UNKNOWN

Constructor Summary

InputSelectManyCheckbox()
Default constructor.

InputSelectManyCheckbox(InputSelectManyCheckbox objectToDuplicate)
Construct by duplicating an existing object.

Method Summary

void	configure(CfgContext context, Node node, NamedNodeMap attributes) Configures the object based upon a node loaded from a schema configuration XML.
InputSelectManyCheckbox	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
UIComponent	makeInputComponent(UiContext context, Section section, Parameter parameter) Makes a Faces HtmlPanelGroup of HtmlSelectBooleanCheckbox components for a parameter.
void	unBind(UiContext context, UIComponent editorForm, Parameter parameter) Triggered on the save event from the metadata editor.

Methods inherited from class com.esri.gpt.catalog.schema.Input

applyHint, evaluateDefault, findInputComponent, formatValue, getDefaultValue, getEditable, getFacesId, getHintMode, getHintResourceKey, getInputValue, getOnChange, getOnClick, getTestResourceKey, makeOutputComponent, setComponentValue, setDefaultValue, setEditable, setFacesId, setHintMode, setHintResourceKey, setOnChange, setOnClick, setTestResourceKey

Methods inherited from class com.esri.gpt.catalog.schema.UiComponent

getStyleClass, makeBR, makeNBSP, setStyleClass

Methods inherited from class com.esri.gpt.catalog.schema.Component

getKey, setKey, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InputSelectManyCheckbox

public InputSelectManyCheckbox()

Default constructor.

InputSelectManyCheckbox

public InputSelectManyCheckbox(InputSelectManyCheckbox objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

configure

public void configure(CfgContext context,
                      Node node,
                      NamedNodeMap attributes)

Configures the object based upon a node loaded from a schema configuration XML.
The super.configure method should be invoked prior to any sub-class configuration.

Overrides:

configure in class Input

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public InputSelectManyCheckbox duplicate()

Produces a deep clone of the object.
The duplication constructor is invoked.
return new InputSelectManyCheckbox(this);

Specified by:

duplicate in class Input

echo

public void echo(StringBuffer sb)

Appends property information for the component to a StringBuffer.
The method is intended to support "FINEST" logging.
super.echo should be invoked prior appending any local information.

Overrides:

echo in class Input

Parameters:

sb - the StringBuffer to use when appending information

makeInputComponent

public UIComponent makeInputComponent(UiContext context,
                                      Section section,
                                      Parameter parameter)

Makes a Faces HtmlPanelGroup of HtmlSelectBooleanCheckbox components for a parameter.

The check boxes are based upon the defined codes for the parameter.

The multiple values associated with the parameter (parameter.getMultipleValues()) are used to establish the selected/unselected status for each check box.

Specified by:

makeInputComponent in class Input

Parameters:

context - the UI context

section - the parent section

parameter - the associated parameter

Returns:

the UI component

unBind

public void unBind(UiContext context,
                   UIComponent editorForm,
                   Parameter parameter)
            throws SchemaException

Triggered on the save event from the metadata editor.

On this event, the selected parameter codes are used to generate the parameter's multiple values (parameter.getMultipleValues()).

Overrides:

unBind in class Input

Parameters:

context - the UI context

editorForm - the Faces HtmlForm for the metadata editor

parameter - the associated parameter

Throws:

SchemaException - if an associated Faces UIComponent cannot be located