HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.widgets
Class CheckboxWidget

java.lang.Object
  extended by com.ibm.hats.transform.widgets.Widget
      extended by com.ibm.hats.transform.widgets.AbstractCheckboxWidget
          extended by com.ibm.hats.transform.widgets.BasicCheckboxWidget
              extended by com.ibm.hats.transform.widgets.CheckboxWidget
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier, HTMLRenderer, com.ibm.hats.transform.renderers.TextRenderer

public class CheckboxWidget
extends BasicCheckboxWidget

CheckboxWidget renders a table of checkboxes with associated descriptions. It takes InputComponentElements as input.

Please refer to the User's Guide for detail on this Widget's settings.

See Also:
InputComponentElement

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.widgets.BasicCheckboxWidget
labeltd, table, td, tr
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractCheckboxWidget
deselectValue, PROPERTY_DESELECT_VALUE, PROPERTY_SELECT_VALUE, selectValue
 
Fields inherited from class com.ibm.hats.transform.widgets.Widget
componentElements, contextAttributes, settings
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
CheckboxWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawItem(EnptuiChoiceComponentElement ecce, String caption, StringBuffer buffer)
          Renders an individual EnptuiChoiceComponentElement as a HTML checkbox input with the specified caption.
protected  void drawItem(InputComponentElement ice, String caption, StringBuffer buffer)
          Renders an individual InputComponentElement as a HTML checkbox input with the specified caption.
protected  void drawSelection(EnptuiSelectionComponentElement esce, StringBuffer buffer)
           
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
protected  boolean renderTable()
          Determines whether or not we should render these checkbox controls in a table or not.
 
Methods inherited from class com.ibm.hats.transform.widgets.BasicCheckboxWidget
getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, isAllowed, setSettings
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractCheckboxWidget
getPropertyPageCount
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getSettings, insertAlign, insertDir, newInstance, setComponentElements, setContextAttribute, setContextAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
Constructor Detail

CheckboxWidget

public CheckboxWidget(ComponentElement[] componentElement,
                      Properties settings)
Class constructor.

Parameters:
componentElement - An array of component elements.
settings - The Properties settings.
See Also:
Widget.Widget(ComponentElement[], Properties)
Method Detail

renderTable

protected boolean renderTable()
Determines whether or not we should render these checkbox controls in a table or not.

Overrides:
renderTable in class BasicCheckboxWidget
Returns:
true to use a table, false to not use a table

drawHTML

public StringBuffer drawHTML()
Description copied from interface: HTMLRenderer
Converts ComponentElements into HTML output for embedding within a Transformation page

Specified by:
drawHTML in interface HTMLRenderer
Overrides:
drawHTML in class BasicCheckboxWidget
Returns:
HTML output

drawSelection

protected void drawSelection(EnptuiSelectionComponentElement esce,
                             StringBuffer buffer)

drawItem

protected void drawItem(InputComponentElement ice,
                        String caption,
                        StringBuffer buffer)
Renders an individual InputComponentElement as a HTML checkbox input with the specified caption.

Overrides:
drawItem in class BasicCheckboxWidget
Parameters:
ice - component to render
caption - caption for checkbox
buffer - output buffer

drawItem

protected void drawItem(EnptuiChoiceComponentElement ecce,
                        String caption,
                        StringBuffer buffer)
Renders an individual EnptuiChoiceComponentElement as a HTML checkbox input with the specified caption.

Parameters:
ecce - The component to render.
caption - The caption for checkbox.
buffer - The output buffer.

isPropertyAllowed

public boolean isPropertyAllowed(String name,
                                 ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not the specified property should be visible in the component or widget settings. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Specified by:
isPropertyAllowed in interface IContextDependent
Overrides:
isPropertyAllowed in class BasicCheckboxWidget
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

HATS 7.5.1 (201005110649)