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 SLRadioButtonWidget

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

public class SLRadioButtonWidget
extends BasicSLRadioButtonWidget

SLRadioButtonWidget renders HTML radio inputs from SelectionComponentElements or FunctionKeyComponentElements.

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

See Also:
SelectionComponentElement, FunctionKeyComponentElement

Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.widgets.BasicSLRadioButtonWidget
defaults, htmlElementFactory, PROPERTY_AUTO_SUBMIT_ON_SELECT, PROPERTY_COLUMNS_PER_ROW, PROPERTY_SHOW_SUBMIT, PROPERTY_SUBMIT_BUTTON_CAPTION
 
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
SLRadioButtonWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
static void drawSelection(ComponentElementList cel, String caption, Properties settings, HTMLElementFactory factory, StringBuffer buffer, ContextAttributes contextAttributes)
          Renders an individual ComponentElementList, either consisting of FunctionKeyComponentElements, or of type SelectionComponentElement, as a table of radio buttons.
static void drawSelection(ComponentElementList cel, String caption, Properties settings, HTMLElementFactory factory, StringBuffer buffer, Hashtable contextAttributes)
          Deprecated.  
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
static void setShapeVista(boolean vista)
           
 
Methods inherited from class com.ibm.hats.transform.widgets.BasicSLRadioButtonWidget
getCustomProperties, getDefaultValues, getPropertyPageCount, insertDir, isAllowed, renderTable
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomPropertiesBiDi, getSettings, insertAlign, insertDir, newInstance, setComponentElements, setContextAttribute, setContextAttributes, setSettings
 
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

SLRadioButtonWidget

public SLRadioButtonWidget(ComponentElement[] componentElements,
                           Properties settings)
Class constructor.

Parameters:
componentElements - An array of component elements.
settings - The Properties 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 BasicSLRadioButtonWidget
Returns:
HTML output

drawSelection

public static void drawSelection(ComponentElementList cel,
                                 String caption,
                                 Properties settings,
                                 HTMLElementFactory factory,
                                 StringBuffer buffer,
                                 Hashtable contextAttributes)
Deprecated. 

Renders an individual ComponentElementList, either consisting of FunctionKeyComponentElements, or of type SelectionComponentElement, as a table of radio buttons.

Parameters:
cel - list of items to render as a radio group
caption - label for whole group of radio buttons
settings - widget settings
factory - and htmlelementfactory to use for html element construction
buffer - output buffer
contextAttributes - current context attributes

drawSelection

public static void drawSelection(ComponentElementList cel,
                                 String caption,
                                 Properties settings,
                                 HTMLElementFactory factory,
                                 StringBuffer buffer,
                                 ContextAttributes contextAttributes)
Renders an individual ComponentElementList, either consisting of FunctionKeyComponentElements, or of type SelectionComponentElement, as a table of radio buttons.

Parameters:
cel - list of items to render as a radio group
caption - label for whole group of radio buttons
settings - widget settings
factory - and htmlelementfactory to use for html element construction
buffer - output buffer
contextAttributes - current context attributes

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

setShapeVista

public static void setShapeVista(boolean vista)

HATS 7.5.1 (201005110649)