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 ItemSelectionLinkWidget

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

public class ItemSelectionLinkWidget
extends Widget
implements HTMLRenderer, IContextDependent

ItemSelectionLinkWidget renders HTML links from ComponentElements. It currently takes InputComponentElements as input.

See Also:
InputComponentElement

Field Summary
protected  String autoSubmitKey
           
protected  String captionType
           
static String CLASS_NAME
           
static Properties defaults
           
protected  HTMLElementFactory htmlElementFactory
           
protected  String linkStyleClass
           
static String PROPERTY_AUTOSUBMITKEY
           
static String PROPERTY_DEFAULT_LINK_CLASS
           
static String PROPERTY_SELECTIONVAL
           
static String PROPERTY_SHOW_INPUTS
           
static String PROPERTY_TARGET
           
protected  String selectionVal
           
protected  String showInputs
           
protected  String styleOverride
           
 
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
ItemSelectionLinkWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor.
 
Method Summary
protected  StringBuffer addDir(StringBuffer s)
           
protected  void drawHiddenTextInput(InputComponentElement ice, String caption, StringBuffer buffer)
           
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawItem(InputComponentElement ice, StringBuffer buffer)
          Renders an individual InputComponentElement as an HTML link to the specified buffer.
protected  void drawTextInput(InputComponentElement ice, String caption, StringBuffer buffer)
          Method drawTextInput.
 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.
protected  boolean is_rtl()
           
 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.
 void setSettings(Properties settings)
          Sets the Widget's settings.
 
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

PROPERTY_TARGET

public static final String PROPERTY_TARGET
See Also:
Constant Field Values

PROPERTY_AUTOSUBMITKEY

public static final String PROPERTY_AUTOSUBMITKEY
See Also:
Constant Field Values

PROPERTY_SELECTIONVAL

public static final String PROPERTY_SELECTIONVAL
See Also:
Constant Field Values

PROPERTY_SHOW_INPUTS

public static final String PROPERTY_SHOW_INPUTS
See Also:
Constant Field Values

PROPERTY_DEFAULT_LINK_CLASS

public static final String PROPERTY_DEFAULT_LINK_CLASS
See Also:
Constant Field Values

defaults

public static Properties defaults

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

linkStyleClass

protected String linkStyleClass

captionType

protected String captionType

selectionVal

protected String selectionVal

autoSubmitKey

protected String autoSubmitKey

showInputs

protected String showInputs

styleOverride

protected String styleOverride
Constructor Detail

ItemSelectionLinkWidget

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

drawItem

protected void drawItem(InputComponentElement ice,
                        StringBuffer buffer)
Renders an individual InputComponentElement as an HTML link to the specified buffer.

Parameters:
ice - to be invoked via link
buffer - output buffer

drawTextInput

protected void drawTextInput(InputComponentElement ice,
                             String caption,
                             StringBuffer buffer)
Method drawTextInput.

Parameters:
ice -
caption -
buffer -

drawHiddenTextInput

protected void drawHiddenTextInput(InputComponentElement ice,
                                   String caption,
                                   StringBuffer 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

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

setSettings

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

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

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

addDir

protected StringBuffer addDir(StringBuffer s)

is_rtl

protected boolean is_rtl()

HATS 7.5.1 (201005110649)