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 BasicSLRadioButtonWidget

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

public class BasicSLRadioButtonWidget
extends Widget
implements HTMLRenderer, IContextDependent

BasicSLRadioButtonWidget renders HTML radio inputs from SelectionComponentElements or FunctionKeyComponentElements.

See Also:
SelectionComponentElement, FunctionKeyComponentElement

Field Summary
static String CLASS_NAME
           
static Properties defaults
           
protected  HTMLElementFactory htmlElementFactory
           
protected static boolean isDBCSSession
           
static String PROPERTY_AUTO_SUBMIT_ON_SELECT
           
static String PROPERTY_COLUMNS_PER_ROW
           
static String PROPERTY_SHOW_SUBMIT
           
static String 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
BasicSLRadioButtonWidget(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.
 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.
static void insertDir(HTMLElement tableElement, HTMLElement labeltdElement, HTMLElement row, Properties settings, ContextAttributes contextAttributes)
          Deprecated. Duplicate function.
 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 static boolean renderTable(ArrayList options, ContextAttributes contextAttributes)
          Determines whether or not to render radio buttons in a table.
 
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
See Also:
Constant Field Values

PROPERTY_COLUMNS_PER_ROW

public static final String PROPERTY_COLUMNS_PER_ROW
See Also:
Constant Field Values

PROPERTY_AUTO_SUBMIT_ON_SELECT

public static final String PROPERTY_AUTO_SUBMIT_ON_SELECT
See Also:
Constant Field Values

PROPERTY_SHOW_SUBMIT

public static final String PROPERTY_SHOW_SUBMIT
See Also:
Constant Field Values

PROPERTY_SUBMIT_BUTTON_CAPTION

public static final String PROPERTY_SUBMIT_BUTTON_CAPTION
See Also:
Constant Field Values

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

isDBCSSession

protected static boolean isDBCSSession

defaults

public static Properties defaults
Constructor Detail

BasicSLRadioButtonWidget

public BasicSLRadioButtonWidget(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

renderTable

protected static boolean renderTable(ArrayList options,
                                     ContextAttributes contextAttributes)
Determines whether or not to render radio buttons in a table.

Returns:
whether to use a table layout

insertDir

public static void insertDir(HTMLElement tableElement,
                             HTMLElement labeltdElement,
                             HTMLElement row,
                             Properties settings,
                             ContextAttributes contextAttributes)
Deprecated. Duplicate function.

Parameters:
tableElement -
labeltdElement -
settings -
contextAttributes -

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

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

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

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

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

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
Returns:
whether or not this Component or Widget is allowed in the specified context

HATS 7.5.1 (201005110649)