Package wt.templateutil.components

Class HTMLCheckBoxComponent

java.lang.Object

wt.templateutil.components.HTMLComponent

wt.templateutil.components.HTMLCheckBoxComponent

public class HTMLCheckBoxComponent
extends HTMLComponent

Deprecated.

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

Fields

Modifier and Type	Field	Description
static final String	NAME	Deprecated.
static final String	TYPE	Deprecated.
static final String	VALUE	Deprecated.

Fields inherited from class wt.templateutil.components.HTMLComponent

DEFAULT_SERVICE_NAME, DEFAULTS_ONLY, PRINT_TAG_ATTR, SERVICENAME

Method Summary

Modifier and Type	Method	Description
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.
String	startComponent(Object value, Properties formData, OutputStream os, Locale locale)	Deprecated.

Methods inherited from class wt.templateutil.components.HTMLComponent

endComponent, getHtmlComponents, getPrintWriter, getServiceName, getTagList, getTagSettings, isInheritStyle, isPrintTagAttributes, isUseDefaultsOnly, main, setInheritStyle, setPrintTagAttributes, setServiceName, 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 Details

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

Method Details

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 -

getTag

public String getTag()

Deprecated.

Returns the tag attribute


Supported API: true

Overrides:

getTag in class HTMLComponent

Parameters:

Object -

OutputStream -

Locale -

Returns:

String