wt.templateutil.components
Class DefaultHTMLComponent

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

Direct Known Subclasses:

DataFormatComponent, DefaultDecimalComponent, EffectivityLinkComponent, HTMLBusinessComponent, HTMLJavaScriptComponent, IconFirstCellComponent, LatestVersionComponent, PDMLinkIconFirstCellComponent, PDMLinkIconFirstNoLinkCellComponent, PDMLinkPendingChangeIconCellComponent, PickerIconFirstCellComponent, QuantityCell, QuantityCellComponent, QuantityHeader, QuantityHeaderComponent, UnitCell, UnitHeader, UserIconNameCellComponent

public class DefaultHTMLComponent

extends HTMLComponent

This is the default HTML component for the template processing system. This component simply displays the string of information passed to it without any formatting HTML. It should rarely be used. In most cases the subclasses should be used instead.

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.
String	defaultComponent Deprecated.
private static String	RESOURCE Deprecated.
private static boolean	VERBOSE 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, NAME, NULLVALUE, PRINT_TAG_ATTR, SERVICENAME, TAG, UPDATE, VIEW

Constructor Summary

DefaultHTMLComponent()
Deprecated.

Method Summary

String	endComponent(Object value, OutputStream os, Locale locale) Deprecated.
void	init(String selector, Object value, HTMLComponentFactory componentFactory, String mode, Properties props) 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, getHtmlComponents, getID, getIdProp, getName, getOID, getPrintWriter, getRealValue, getServiceName, getState, getTag, 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.

VERBOSE

private static boolean VERBOSE

Deprecated.

defaultComponent

public String defaultComponent

Deprecated.

Constructor Detail

DefaultHTMLComponent

public DefaultHTMLComponent()

Deprecated.

Method Detail

init

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

Deprecated.

Calls the super class init method.

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

startComponent

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

Deprecated.

This is the default implementation for startComponent. It should most likely be overridden in the subclass.
This implementation returns an empty String: ""


Supported API: true

Overrides:

startComponent in class HTMLComponent

Parameters:

value -

formData -

os -

locale -

Returns:

String

endComponent

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

Deprecated.

This is the default implementation for endComponent. It should most likely be overridden in the subclass.
This implementation returns an empty String: ""


Supported API: true

Overrides:

endComponent in class HTMLComponent

Parameters:

value -

os -

locale -

Returns:

String