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 ButtonWidget

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

public class ButtonWidget
extends BasicButtonWidget

ButtonWidget renders a set of buttons in a table or horizontally with a specified separator. It can currently take FunctionKeyComponentElements or SelectionComponentElements as inputs.

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

See Also:
FunctionKeyComponentElement, SelectionComponentElement

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.widgets.BasicButtonWidget
buttonStyleClass, defaults, htmlElementFactory
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractButtonWidget
CAPTION_TYPE_BOTH, CAPTION_TYPE_DESCRIPTION, CAPTION_TYPE_LEADING_TOKEN, captionType, LAYOUT_SEPARATED, LAYOUT_TABLE, PROPERTY_CAPTION_TYPE, PROPERTY_COLUMNS_PER_ROW, PROPERTY_LAYOUT, PROPERTY_SEPARATOR
 
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
ButtonWidget(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, StringBuffer buffer)
          Renders an individual EnptuiChoiceComponentElement as a button.
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
 
Methods inherited from class com.ibm.hats.transform.widgets.BasicButtonWidget
drawItem, drawItem, getCustomProperties, getDefaultValues, getPropertyPageCount
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractButtonWidget
isAllowed, 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
Constructor Detail

ButtonWidget

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

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
Overrides:
drawHTML in class BasicButtonWidget
Returns:
HTML output

drawItem

protected void drawItem(EnptuiChoiceComponentElement ecce,
                        StringBuffer buffer)
Renders an individual EnptuiChoiceComponentElement as a button. Rendering may or may not take place within a table cell, depending on widget settings.

Parameters:
ecce - enptui choice to render
buffer - 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 AbstractButtonWidget
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

HATS 7.5.1 (201005110649)