wt.templateutil.components
Class HTMLComponent

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

Direct Known Subclasses:

DefaultHTMLComponent, DefaultStringComponent, HTMLCheckBoxComponent, HTMLFont, HTMLImgComponent, HTMLLinkComponent, HTMLSelectComponent, HTMLTableCellComponent, HTMLTableComponent, HTMLTextInputComponent, LifeCycleStateComponent, NameComponent

Deprecated.

public abstract class HTMLComponent
extends Object

This abstract component contains the common processing code for displaying and HTML component. It handles tag fomat, tag attributes, and nesting of components.In most cases any HTML component can be displayed simply by calling the show() method defined in this class.

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: true

Field Summary

static String	DEFAULT_SERVICE_NAME Deprecated.
static String	DEFAULTS_ONLY Deprecated.
static String	PRINT_TAG_ATTR Deprecated.
static String	SERVICENAME Deprecated.

Method Summary

String	endComponent(Object value, OutputStream os, Locale locale) Deprecated.
Vector	getHtmlComponents() Deprecated.
PrintWriter	getPrintWriter(OutputStream out, Locale locale) Deprecated.
String	getServiceName() Deprecated.
String	getTag() Deprecated.
String[]	getTagList() Deprecated.
Hashtable	getTagSettings() Deprecated.
void	init(String selector, Object value, HTMLComponentFactory componentFactory, String mode, Properties props) Deprecated.
boolean	isInheritStyle() Deprecated.
boolean	isPrintTagAttributes() Deprecated.
boolean	isUseDefaultsOnly() Deprecated.
static void	main(String[] args) Deprecated.
void	setInheritStyle(boolean a_InheritStyle) Deprecated.
void	setPrintTagAttributes(boolean a_PrintTagAttributes) Deprecated.
void	setServiceName(String a_ServiceName) Deprecated.
void	setTag(String a_Tag) Deprecated.
void	setTagList(String[] a_TagList) Deprecated.
abstract void	setTagListArray() Deprecated.
void	setTagListDefaults(WTProperties defaultProperties) Deprecated.
void	setTagSettings(Hashtable a_TagSettings) Deprecated.
void	setTagValue(String tagID, String tagValue) Deprecated.
void	setUseDefaultsOnly(boolean a_UseDefaultsOnly) Deprecated.
String	show(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.
String	showSubComponents(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.
String	startComponent(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

Deprecated.

Supported API: true

See Also:

Constant Field Values

DEFAULTS_ONLY

public static final String DEFAULTS_ONLY

Deprecated.

Supported API: true

See Also:

Constant Field Values

PRINT_TAG_ATTR

public static final String PRINT_TAG_ATTR

Deprecated.

Supported API: true

See Also:

Constant Field Values

SERVICENAME

public static final String SERVICENAME

Deprecated.

Supported API: true

See Also:

Constant Field Values

Method Detail

getTagList

public String[] getTagList()

Deprecated.

Gets the value of the attribute: tagList.

Supported API: true

Returns:

String[]

setTagList

public void setTagList(String[] a_TagList)

Deprecated.

Sets the value of the attribute: tagList.

Supported API: true

Parameters:

a_TagList -

getTagSettings

public Hashtable getTagSettings()

Deprecated.

Gets the value of the attribute: tagSettings.

Supported API: true

Returns:

Hashtable

setTagSettings

public void setTagSettings(Hashtable a_TagSettings)

Deprecated.

Sets the value of the attribute: tagSettings.

Supported API: true

Parameters:

a_TagSettings -

isUseDefaultsOnly

public boolean isUseDefaultsOnly()

Deprecated.

Gets the value of the attribute: useDefaultsOnly.

Supported API: true

Returns:

boolean

setUseDefaultsOnly

public void setUseDefaultsOnly(boolean a_UseDefaultsOnly)

Deprecated.

Sets the value of the attribute: useDefaultsOnly.

Supported API: true

Parameters:

a_UseDefaultsOnly -

getServiceName

public String getServiceName()

Deprecated.

Gets the value of the attribute: serviceName.

Supported API: true

Returns:

String

setServiceName

public void setServiceName(String a_ServiceName)

Deprecated.

Sets the value of the attribute: serviceName.

Supported API: true

Parameters:

a_ServiceName -

getTag

public String getTag()

Deprecated.

Gets the value of the attribute: tag.

Supported API: true

Returns:

String

setTag

public void setTag(String a_Tag)

Deprecated.

Sets the value of the attribute: tag.

Supported API: true

Parameters:

a_Tag -

isPrintTagAttributes

public boolean isPrintTagAttributes()

Deprecated.

Gets the value of the attribute: printTagAttributes.

Supported API: true

Returns:

boolean

setPrintTagAttributes

public void setPrintTagAttributes(boolean a_PrintTagAttributes)

Deprecated.

Sets the value of the attribute: printTagAttributes.

Supported API: true

Parameters:

a_PrintTagAttributes -

isInheritStyle

public boolean isInheritStyle()

Deprecated.

Gets the value of the attribute: inheritStyle.

Supported API: true

Returns:

boolean

setInheritStyle

public void setInheritStyle(boolean a_InheritStyle)

Deprecated.

Sets the value of the attribute: inheritStyle.

Supported API: true

Parameters:

a_InheritStyle -

getHtmlComponents

public Vector getHtmlComponents()

Deprecated.

Gets the object for the association that plays role: htmlComponents.

Supported API: true

Returns:

Vector

show

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

Deprecated.

This method is the main control for the Display of all HTMLComponent subclasses. It first calls startComponent, then showSubComponents, and then endComponent. It returns a string that is the concatenation of the results of these three methods. A call to show() should be all that is needed to display any subclass component.

Supported API: true

Parameters:

value -

formData -

os -

locale -

Returns:

String

init

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

Deprecated.

Initializes the HTML componenet using information from the Properties object.

Supported API: true

Parameters:

selector -

value - The current context object

componentFactory -

mode -

props - provides the service name and the current key if they exist.

startComponent

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

Deprecated.

Displays the standard format of a starting HTML tag include the opening less than, the tag name, the key value pairs that are the tag attributes, and the closing greater than.

Supported API: true

Parameters:

value -

formData -

os -

locale -

Returns:

String

endComponent

public String endComponent(Object value,
                           OutputStream os,
                           Locale locale)

Deprecated.

Displays the default format for a closing HTML tag. Including the opening less than, the tag name, and the closing greater than.

Supported API: true

Parameters:

value -

os -

locale -

Returns:

String

showSubComponents

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

Deprecated.

Returns a string that is the contcatenation of the result of calling show() on all the associated subComponents sequentially.

Supported API: true

Parameters:

value -

formData -

os -

locale -

Returns:

String

setTagListArray

public abstract 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

setTagListDefaults

public void setTagListDefaults(WTProperties defaultProperties)

Deprecated.

Supported API: true

Parameters:

defaultProperties -

setTagValue

public void setTagValue(String tagID,
                        String tagValue)

Deprecated.

This method stores the value that corresponds to one of the keys in the TagList array.

Supported API: true

Parameters:

tagID - The key value that should be found in the taglist array.

tagValue - the value that should be stored.

getPrintWriter

public PrintWriter getPrintWriter(OutputStream out,
                                  Locale locale)

Deprecated.

Supported API: true

Parameters:

out -

locale -

Returns:

PrintWriter

main

public static void main(String[] args)

Deprecated.

Supported API: true

Parameters:

args -