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 ButtonTableWidget

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

public class ButtonTableWidget
extends AbstractButtonTableWidget
implements HTMLRenderer

ButtonTableWidget renders a table of buttons with associated descriptions. It can currently take FunctionKeyComponentElements or SelectionComponentElements as inputs.

See Also:
FunctionKeyComponentElement, SelectionComponentElement

Field Summary
static String CLASS_NAME
           
static Properties defaults
          Default settings for this Widget.
protected  HTMLElementFactory htmlElementFactory
          HTMLElementFactory to be used when rendering ComponentElements.
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractButtonTableWidget
columnsPerRow, PROPERTY_COLUMNS_PER_ROW
 
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
ButtonTableWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor for ButtonTableWidget.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawItem(FunctionKeyComponentElement fkce, StringBuffer buffer)
          Renders an individual FunctionKeyComponentElement as two table cells, first containing the button, second containing the description of the key.
protected  void drawItem(ListItemComponentElement lice, StringBuffer buffer, Properties settings)
          Renders an individual ListItemComponentElement as two table cells, first containing the button, second containing the description of the list item.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractButtonTableWidget
isAllowed, isPropertyAllowed, setSettings
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomPropertiesBiDi, 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
HTMLElementFactory to be used when rendering ComponentElements.


defaults

public static Properties defaults
Default settings for this Widget.

Constructor Detail

ButtonTableWidget

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

Parameters:
componentElement -
settings -
See Also:
Widget.Widget(ComponentElement[], Properties)
Method Detail

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(FunctionKeyComponentElement fkce,
                        StringBuffer buffer)
Renders an individual FunctionKeyComponentElement as two table cells, first containing the button, second containing the description of the key. Called in the middle of rendering a TR.

Parameters:
fkce - function key to render
buffer - output buffer

drawItem

protected void drawItem(ListItemComponentElement lice,
                        StringBuffer buffer,
                        Properties settings)
Renders an individual ListItemComponentElement as two table cells, first containing the button, second containing the description of the list item. Called in the middle of rendering a TR.

Parameters:
lice - The list item to render.
buffer - The output buffer.

getPropertyPageCount

public int getPropertyPageCount()
Description copied from interface: ICustomPropertySupplier
Returns the number of property pages associated with this object.

Note: Currently only 0 or 1 pages are supported.

Specified by:
getPropertyPageCount in interface ICustomPropertySupplier
Overrides:
getPropertyPageCount in class Widget
Returns:
the number of defined property pages used to configure this object, or 0 if there are none

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

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

HATS 7.5.1 (201005110649)