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 BasicCheckboxWidget

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
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier, HTMLRenderer, com.ibm.hats.transform.renderers.TextRenderer
Direct Known Subclasses:
CheckboxWidget

public class BasicCheckboxWidget
extends AbstractCheckboxWidget
implements HTMLRenderer

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

See Also:
InputComponentElement

Field Summary
static String CLASS_NAME
           
protected static Properties defaults
           
protected  HTMLElementFactory htmlElementFactory
           
protected  HTMLElement labeltd
           
protected  HTMLElement table
           
protected  HTMLElement td
           
protected  HTMLElement 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
BasicCheckboxWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawItem(InputComponentElement ice, String caption, StringBuffer buffer)
          Renders an individual InputComponentElement as a HTML checkbox input with the specified caption.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Vector getCustomPropertiesBiDi(int iPageNumber, Properties properties, ResourceBundle bundle)
           
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 boolean isAllowed(ContextAttributes contextAttributes)
          Gets whether or not this object should be visible in the studio given some context attributes.
 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.
 void setSettings(Properties newSettings)
          Sets the Widget's settings.
 
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
See Also:
Constant Field Values

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

table

protected HTMLElement table

td

protected HTMLElement td

tr

protected HTMLElement tr

labeltd

protected HTMLElement labeltd

defaults

protected static Properties defaults
Constructor Detail

BasicCheckboxWidget

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

Parameters:
componentElement -
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.

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
Returns:
HTML output

drawItem

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

Parameters:
ice - component to render
caption - caption for checkbox
buffer - output buffer

getDefaultValues

public Properties getDefaultValues(int iPageNumber)
Description copied from interface: ICustomPropertySupplier
Returns this object's default property values.

Specified by:
getDefaultValues in interface ICustomPropertySupplier
Overrides:
getDefaultValues in class Widget
Parameters:
iPageNumber - page for which to retrieve default properties
Returns:
object's default properties

getCustomPropertiesBiDi

public Vector getCustomPropertiesBiDi(int iPageNumber,
                                      Properties properties,
                                      ResourceBundle bundle)
Overrides:
getCustomPropertiesBiDi in class Widget

getCustomProperties

public Vector getCustomProperties(int iPageNumber,
                                  Properties properties,
                                  ResourceBundle bundle)
Description copied from interface: ICustomPropertySupplier
Returns a list of this object's custom properties. Items must be of type com.ibm.hats.common.HCustomProperty.

Specified by:
getCustomProperties in interface ICustomPropertySupplier
Overrides:
getCustomProperties in class Widget
Parameters:
iPageNumber - page number containing desired properties
properties - existing values for properties defined here
bundle - ResourceBundle containing NLS descriptions for the properties
Returns:
Vector containing all the custom properties for this object, or null if there are none
See Also:
HCustomProperty

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 AbstractCheckboxWidget
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

setSettings

public void setSettings(Properties newSettings)
Description copied from class: Widget
Sets the Widget's settings.

Overrides:
setSettings in class Widget
Parameters:
newSettings - The Properties to set.

isAllowed

public boolean isAllowed(ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not this object should be visible in the studio given some context attributes. 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:
isAllowed in interface IContextDependent
Overrides:
isAllowed in class AbstractCheckboxWidget
Returns:
whether or not this Component or Widget is allowed in the specified context

HATS 7.5.1 (201005110649)