wt.templateutil.components
Class DisableableCheckBoxCellComponent

java.lang.Object
  extended bywt.templateutil.components.HTMLComponent
      extended bywt.templateutil.components.HTMLTableCellComponent
          extended bywt.templateutil.components.DisableableCheckBoxCellComponent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CheckBoxCellComponent, CheckedOutCopyDisabledCheckBoxCellComponent

public abstract class DisableableCheckBoxCellComponent
extends HTMLTableCellComponent
implements Serializable

This abstract class contains common code used to display different types of check boxes in a cell in an HTML Table.

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

See Also:
Serialized Form

Field Summary
static String BEGIN_CHECKBOX_NAME
          Deprecated.  
private static String CLASSNAME
          Deprecated.  
protected static String COMPONENT_ID_CHECKBOX_SUFFIX
          Deprecated.  
static String CONTEXT_SEPARATOR
          Deprecated.  
private static String RESOURCE
          Deprecated.  
private  String tableContext
          Deprecated.  
 
Fields inherited from class wt.templateutil.components.HTMLTableCellComponent
ALIGN, BGCOLOR, COLSPAN, HEIGHT, NOWRAP, ROWSPAN, showBold, TAG, TD_ALIGN, TD_CLASS, TD_COLSPAN, TD_HEIGHT, TD_ID, TD_NOWRAP, TD_ROWSPAN, TD_VALIGN, TD_WIDTH, VALIGN, WIDTH
 
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, UPDATE, VIEW
 
Constructor Summary
DisableableCheckBoxCellComponent()
          Deprecated.  
 
Method Summary
 String getTableContext()
          Deprecated.  
 void init(String selector, Object value, HTMLComponentFactory componentFactory, String mode, Properties props)
          Deprecated.  
protected abstract  boolean isDisabled(Object source)
          Deprecated.  
 void setTableContext(String newTableContext)
          Deprecated.  
 String show(Object value, Properties formData, OutputStream os, Locale locale)
          Deprecated. This method is the main control for the Display of all HTMLComponent subclasses.
 
Methods inherited from class wt.templateutil.components.HTMLTableCellComponent
getTag, isShowBold, setShowBold, setTagListArray, showSubComponents, startComponent
 
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
 
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. 

tableContext

private String tableContext
Deprecated. 

CONTEXT_SEPARATOR

public static String CONTEXT_SEPARATOR
Deprecated.  

CONTEXT_SEPERATOR is a constant string that is used to separate the context information that is contained in the HTML component name

Supported API: true


BEGIN_CHECKBOX_NAME

public static String BEGIN_CHECKBOX_NAME
Deprecated.  

BEGIN_CHECKBOX_NAME is a constant string that is used as the beginning portion of the name attribute on the HTML tag when the check box is drawn.

Supported API: true


COMPONENT_ID_CHECKBOX_SUFFIX

protected static final String COMPONENT_ID_CHECKBOX_SUFFIX
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

DisableableCheckBoxCellComponent

public DisableableCheckBoxCellComponent()
Deprecated. 
Method Detail

init

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



Supported API: false

Overrides:
init in class HTMLTableCellComponent
Parameters:
selector -
value -
componentFactory -
mode -
props -

isDisabled

protected abstract boolean isDisabled(Object source)
Deprecated.  

Implementations should return true if the checkbox in this cell component should be disabled based on the state of the argument value object, and false otherwise.

Supported API: false

Parameters:
source -
Returns:
boolean

getTableContext

public String getTableContext()
Deprecated. 

setTableContext

public void setTableContext(String newTableContext)
Deprecated. 

show

public String show(Object value,
                   Properties formData,
                   OutputStream os,
                   Locale locale)
Deprecated. 
Description copied from class: HTMLComponent
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

Overrides:
show in class HTMLComponent
Parameters:
value -
formData -
os -
locale -
Returns:
String