wt.templateutil.components
Class HTMLCheckBoxComponent

java.lang.Object
  wt.templateutil.components.HTMLComponent
      wt.templateutil.components.HTMLCheckBoxComponent

public class HTMLCheckBoxComponent

extends HTMLComponent

This class displays an HTML checkbox. It handles enabling, Disabling, initial state, and grouping the checkbox in a group with a "select all" checkbox.

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

Supported API: true

Extendable: false

Field Summary

private static String	CLASSNAME Deprecated.
private boolean	disabled Deprecated.
static String	INPUT_ID Deprecated.
static String	INPUT_NAME Deprecated.
static String	INPUT_TYPE Deprecated.
static String	INPUT_VALUE Deprecated.
static String	NAME Deprecated.
private static String	RESOURCE Deprecated.
private String	tag Deprecated.
static String	TAG Deprecated.
static String	TYPE Deprecated.
static String	VALUE Deprecated.

Fields inherited from class wt.templateutil.components.HTMLComponent

CLASS, COMPONENT_ID, COMPONENT_ID_SEPARATOR, CREATE, DEFAULT_SERVICE_NAME, DEFAULTS_ONLY, EMPTY_STRING, ID, ID_US_ENGLISH_LOCALE, NULLVALUE, PRINT_TAG_ATTR, SERVICENAME, UPDATE, VERBOSE, VIEW

Constructor Summary

HTMLCheckBoxComponent()
Deprecated.

Method Summary

String	getTag() Deprecated.
void	init(String selector, Object value, HTMLComponentFactory componentFactory, String mode, Properties props) Deprecated.
boolean	isDisabled() Deprecated.
void	setDisabled(boolean a_Disabled) Deprecated.
void	setTagListArray() Deprecated.
String	startComponent(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.

Methods inherited from class wt.templateutil.components.HTMLComponent

appendID, appendID, appendToID, appendToID, createIDForComponent, endComponent, getHtmlComponents, getID, getIdProp, getName, getOID, getPrintWriter, getRealValue, getServiceName, getState, getTagID, getTagIDKey, getTagList, getTagSettings, getURLFactory, insertID, insertID, isInheritStyle, isPrintTagAttributes, isUseDefaultsOnly, main, putTagID, putTagID, removeID, removeTagID, setHtmlComponents, setID, setInheritStyle, setName, setPrintTagAttributes, setServiceName, setState, setTag, setTagList, setTagListDefaults, setTagSettings, setTagValue, setUseDefaultsOnly, show, showSubComponents

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

TYPE

public static final String TYPE

Deprecated.

Supported API: true

See Also:

Constant Field Values

NAME

public static final String NAME

Deprecated.

Supported API: true

See Also:

Constant Field Values

VALUE

public static final String VALUE

Deprecated.

Supported API: true

See Also:

Constant Field Values

disabled

private boolean disabled

Deprecated.

tag

private String tag

Deprecated.

TAG

public static final String TAG

Deprecated.

See Also:

Constant Field Values

INPUT_TYPE

public static final String INPUT_TYPE

Deprecated.

See Also:

Constant Field Values

INPUT_NAME

public static final String INPUT_NAME

Deprecated.

See Also:

Constant Field Values

INPUT_VALUE

public static final String INPUT_VALUE

Deprecated.

See Also:

Constant Field Values

INPUT_ID

public static final String INPUT_ID

Deprecated.

See Also:

Constant Field Values

Constructor Detail

HTMLCheckBoxComponent

public HTMLCheckBoxComponent()

Deprecated.

Method Detail

isDisabled

public boolean isDisabled()

Deprecated.

Gets the value of the attribute: disabled.

Supported API: true

Returns:

boolean

setDisabled

public void setDisabled(boolean a_Disabled)

Deprecated.

Sets the value of the attribute: disabled.

Supported API: true

Parameters:

a_Disabled -

startComponent

public String startComponent(Object value,
                             Properties formData,
                             OutputStream os,
                             Locale locale)

Deprecated.

Displays the HTML tag that constitutes the begining of the component. Appropriately initializes the value of the checkbox to be checked or unchecked.

Supported API: true

Overrides:

startComponent in class HTMLComponent

Parameters:

value -

formData -

os -

locale -

Returns:

String

init

public void init(String selector,
                 Object value,
                 HTMLComponentFactory componentFactory,
                 String mode,
                 Properties props)

Deprecated.

Sets the type of the component to checkbox, registers an onclick event to unclick any associated "All" checkbox, and disables or enables the checkbox as appropriate.

Supported API: true

Overrides:

init in class HTMLComponent

Parameters:

selector -

value -

componentFactory -

mode -

props -

setTagListArray

public void setTagListArray()

Deprecated.

Initializes the TagListArray to an array of values representing the possible attributes on the tag. For example one possible array would be: {TYPE, NAME, VALUE, ID} these attributes are later displayed in the HTML as key value pairs, for example "NAME=checkbox1"

Supported API: true

Specified by:

setTagListArray in class HTMLComponent

getTag

public String getTag()

Deprecated.

Returns the tag attribute


Supported API: true

Overrides:

getTag in class HTMLComponent

Returns:

String