com.esri.gpt.catalog.schema
Class Label

java.lang.Object
  com.esri.gpt.catalog.schema.Component
      com.esri.gpt.catalog.schema.UiComponent
          com.esri.gpt.catalog.schema.Label

public class Label
extends UiComponent

Label component associated with a metadata schema.

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

Example:
<label resourceKey="catalog.mdParam.description.abstract" styleClass="sectionCaption"/>

Constructor Summary

Label()
Default constructor.

Label(Label 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.
Label	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
String	getResourceKey() Gets the UI property bundle resource key.
UIComponent	makeEditorLabel(UiContext context, Section section, Parameter parameter) Makes a Faces HtmlOutputLabel for a metadata editor parameter.
void	setResourceKey(String key) Sets the UI property bundle resource key.

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

Label

public Label()

Default constructor.

Label

public Label(Label objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getResourceKey

public String getResourceKey()

Gets the UI property bundle resource key.

Returns:

the resource key

setResourceKey

public void setResourceKey(String key)

Sets the UI property bundle resource key.
The key will be trimmed.
A null key is treated as an empty string.

Parameters:

key - the resource key

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.

The following attributes are configured:
key resourceKey

Overrides:

configure in class UiComponent

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public Label duplicate()

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

Specified by:

duplicate in class Component

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 UiComponent

Parameters:

sb - the StringBuffer to use when appending information

makeEditorLabel

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

Makes a Faces HtmlOutputLabel for a metadata editor parameter.

Parameters:

context - the UI context

section - the parent section

parameter - the associated parameter

Returns:

the UI component