wt.templateutil.components
Class HTMLBusinessComponent

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

Direct Known Subclasses:

DefaultBusinessComponent, EnumeratedAttribute, TimeStampComponent

public abstract class HTMLBusinessComponent

extends DefaultHTMLComponent

This abstract class contains common code used by components that display information about primary business objects.

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.
protected static String	COMPONENT_ID_BUSINESS_SUFFIX Deprecated.
private String	formComponentSelector Deprecated.
private String	formElementName Deprecated.
private String	mode Deprecated.
private static String	RESOURCE Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from class wt.templateutil.components.DefaultHTMLComponent

defaultComponent

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

HTMLBusinessComponent()
Deprecated.

Method Summary

private String	getBaseID(Object value, Properties formData) Deprecated.
String	getFormComponentSelector() Deprecated.
String	getFormElementName() Deprecated.
String	getMode() Deprecated.
abstract Object	getPresentationObject(Object value, Properties formData, Locale locale) Deprecated.
void	init(String selector, Object value, HTMLComponentFactory componentFactory, String mode, Properties props) Deprecated.
private String	removeAnchorText(String anchorString) Deprecated.
void	setFormComponentSelector(String a_FormComponentSelector) Deprecated.
void	setFormElementName(String a_FormElementName) Deprecated.
void	setMode(String a_Mode) Deprecated.
String	show(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.

Methods inherited from class wt.templateutil.components.DefaultHTMLComponent

endComponent, setTagListArray, startComponent

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, 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.

mode

private String mode

Deprecated.

formElementName

private String formElementName

Deprecated.

formComponentSelector

private String formComponentSelector

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

COMPONENT_ID_BUSINESS_SUFFIX

protected static final String COMPONENT_ID_BUSINESS_SUFFIX

Deprecated.

See Also:

Constant Field Values

Constructor Detail

HTMLBusinessComponent

public HTMLBusinessComponent()

Deprecated.

Method Detail

getMode

public String getMode()

Deprecated.

Gets the value of the attribute: mode.

Supported API: true

Returns:

String

setMode

public void setMode(String a_Mode)

Deprecated.

Sets the value of the attribute: mode.

Supported API: true

Parameters:

a_Mode -

getFormElementName

public String getFormElementName()

Deprecated.

Gets the value of the attribute: formElementName.

Supported API: true

Returns:

String

setFormElementName

public void setFormElementName(String a_FormElementName)

Deprecated.

Sets the value of the attribute: formElementName.

Supported API: true

Parameters:

a_FormElementName -

getFormComponentSelector

public String getFormComponentSelector()

Deprecated.

Gets the value of the attribute: formComponentSelector.

Supported API: true

Returns:

String

setFormComponentSelector

public void setFormComponentSelector(String a_FormComponentSelector)

Deprecated.

Sets the value of the attribute: formComponentSelector.

Supported API: true

Parameters:

a_FormComponentSelector -

getPresentationObject

public abstract Object getPresentationObject(Object value,
                                             Properties formData,
                                             Locale locale)

Deprecated.

This abstract method must be implented by the subclasses to correctly return the BusinessObject that the component should present to the user. If the business object is a WtAttribute and the attribute value is null " : will be returned for the display string.

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

Parameters:

value -

formData -

locale -

Returns:

Object

show

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

Deprecated.

This method contains common code to show an HTMLBusinessComponent. It handles strings, WTAttributes, and any associated SubComponents. If the component is a WtAttribute and the property "preserveFormatting=true" in the MethodContext, the characters carriage return, line feed, '<', '>', and multiple adjacent spaces will be encoded for HTML display as "
", "
", "<", ">", and " ...", respectively. The preserveFormatting flag can be set using the Windchill script method DefaultTemplateProcessor.setMethodContextProperty().

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

Overrides:

show 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.

This method contains the common code to initialize an HTMLBusinessComponent in view, create, or update mode.


Supported API: true

Overrides:

init in class DefaultHTMLComponent

Parameters:

selector -

value -

componentFactory -

mode -

props -

removeAnchorText

private String removeAnchorText(String anchorString)

Deprecated.

getBaseID

private String getBaseID(Object value,
                         Properties formData)

Deprecated.