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 LabelWidget

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

public class LabelWidget
extends Widget
implements HTMLRenderer

LabelWidget renders a set of TextComponentElements as plain HTML text.

See Also:
TextComponentElement

Field Summary
static String CLASS_NAME
           
protected  int codepage
           
protected static Properties defaults
           
protected  String dirWidget
           
protected  HTMLElementFactory htmlElementFactory
           
protected  boolean inCompactRendering
           
protected  boolean isBIDI
           
static String PROPERTY_TRIM
           
protected  String style
           
protected  String styleClass
           
protected  boolean trim
           
 
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
LabelWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawSelection(TextComponentElement tce, StringBuffer buffer)
          Renders an individual TextComponentElement as a HTML span element to the specified StringBuffer.
 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.
 void setContextAttributes(ContextAttributes contextAttributes)
          Sets the contextAttributes of this Widget
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomPropertiesBiDi, getSettings, insertAlign, insertDir, newInstance, setComponentElements, setContextAttribute, 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_TRIM

public static final String PROPERTY_TRIM
See Also:
Constant Field Values

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

defaults

protected static Properties defaults

trim

protected boolean trim

style

protected String style

styleClass

protected String styleClass

codepage

protected int codepage

isBIDI

protected boolean isBIDI

dirWidget

protected String dirWidget

inCompactRendering

protected boolean inCompactRendering
Constructor Detail

LabelWidget

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

drawSelection

protected void drawSelection(TextComponentElement tce,
                             StringBuffer buffer)
Renders an individual TextComponentElement as a HTML span element to the specified StringBuffer. Additionally HTML escapes the text content of the TextComponentElement.

Parameters:
tce - text to render
buffer - output buffer

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

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

setContextAttributes

public void setContextAttributes(ContextAttributes contextAttributes)
Description copied from class: Widget
Sets the contextAttributes of this Widget

Overrides:
setContextAttributes in class Widget
Parameters:
contextAttributes - The contextAttributes to set

HATS 7.5.1 (201005110649)