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 InputWidget

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

public class InputWidget
extends AbstractInputWidget
implements HTMLRenderer

ButtonWidget renders HTML input fields, individually or in tables. It can currently take InputComponentElements as inputs.

See Also:
InputComponentElement

Field Summary
static String CLASS_NAME
           
protected static Properties defaults
           
protected  HTMLElementFactory htmlElementFactory
           
static String PROPERTY_LOGICAL_CAPTION
           
static String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
           
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractInputWidget
PROPERTY_CAPTION, PROPERTY_CAPTION_SOURCE, PROPERTY_COLUMNS_PER_ROW, PROPERTY_ELIMINATE_MAX_LENGTH, PROPERTY_ENABLE_CHECK_ATTRIBUTES, PROPERTY_ENABLE_INPUT_RESTRICTIONS, PROPERTY_ENABLE_NUMERIC_LOCK, PROPERTY_MAXLEN, PROPERTY_OVERRIDE_MAXLEN, PROPERTY_OVERRIDE_SIZE, PROPERTY_READ_ONLY, PROPERTY_SIZE, PROPERTY_STRIP_UNDERLINES_ON_INPUTS, PROPERTY_TRIM_SPACES_ON_INPUTS, SOURCE_COMPONENT, SOURCE_VALUE
 
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
InputWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawTextInput(InputComponentElement ice, String caption, StringBuffer buffer)
          Renders an individual InputComponentElement as an html input to the specified string buffer.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Vector getCustomPropertiesBiDi(int iPageNumber, Properties properties, ResourceBundle bundle)
           
 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 renderTable()
          Decides whether or not a table should be used in the rendering based on the componentElements.
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractInputWidget
isAllowed, isPropertyAllowed
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, 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

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

defaults

protected static Properties defaults

PROPERTY_LOGICAL_CAPTION

public static final String PROPERTY_LOGICAL_CAPTION
See Also:
Constant Field Values

PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION

public static final String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
See Also:
Constant Field Values
Constructor Detail

InputWidget

public InputWidget(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 boolean renderTable()
Decides whether or not a table should be used in the rendering based on the componentElements.


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

drawTextInput

protected void drawTextInput(InputComponentElement ice,
                             String caption,
                             StringBuffer buffer)
Renders an individual InputComponentElement as an html input to the specified string buffer. It also renders an invisible accessibility label using the specified caption. This rendering may take place within a table cell.

Parameters:
ice - input to render
caption - caption for accessibility label
buffer - 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

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

getCustomPropertiesBiDi

public Vector getCustomPropertiesBiDi(int iPageNumber,
                                      Properties properties,
                                      ResourceBundle bundle)
Overrides:
getCustomPropertiesBiDi in class Widget

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

HATS 7.5.1 (201005110649)