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 AbstractFieldWidget

java.lang.Object
  extended by com.ibm.hats.transform.widgets.Widget
      extended by com.ibm.hats.transform.widgets.AbstractFieldWidget
All Implemented Interfaces:
ICustomPropertySupplier, com.ibm.hats.transform.renderers.TextRenderer
Direct Known Subclasses:
AbstractSubfileWidget, FieldWidget

public abstract class AbstractFieldWidget
extends Widget


Field Summary
protected  String actionKey
           
static String ALIGNMENT_CHAR_BY_CHAR
           
static String ALIGNMENT_NORMAL
           
static String ALIGNMENT_WORD_BY_WORD
           
protected  boolean allowPositionOnProtected
           
protected  boolean characterRendering
           
protected static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
static String LAYOUT_SEPARATED
           
static String LAYOUT_TABLE
           
protected  boolean mapExtendedAttributes
           
protected  boolean mapForegroundColors
           
static String PROPERTY_ADD_NOWRAP_TO_TD
           
static String PROPERTY_ADD_REVERSE_COLOR_CLASS_TO_TD_TAG
           
static String PROPERTY_ADD_SPAN_TAGS_TO_TEXT
           
static String PROPERTY_ALIGNMENT
           
static String PROPERTY_APPLY_COLUMN_SEPARATOR_STYLE_TO_INPUTS
           
static String PROPERTY_APPLY_EXTENDED_STYLE_TO_INSIDE_TD_TAG
           
static String PROPERTY_APPLY_EXTENDED_STYLE_TO_TD_TAG
           
static String PROPERTY_APPLY_UNDERLINE_STYLE_TO_INPUTS
           
static String PROPERTY_AUTO_KEY_FOR_PROTECTED_FIELD_LINKS
           
static String PROPERTY_CHARACTER_RENDERING
           
static String PROPERTY_CLASSES_FOR_TD
           
static String PROPERTY_ENABLE_NUMERIC_LOCK
           
static String PROPERTY_FIELD_STYLE_CLASS
           
static String PROPERTY_LAYOUT
           
static String PROPERTY_MAP_EXTENDED_ATTRIBUTES
           
static String PROPERTY_OMIT_EXTRANEOUS_TABLES
           
static String PROPERTY_OPTIMIZED_OUTPUT
           
static String PROPERTY_PRESERVE_COLORS
           
static String PROPERTY_PROTECTED_LINK_STYLE_CLASS
           
static String PROPERTY_READ_ONLY
           
static String PROPERTY_RENDER_PROTECTED_TEXT_AS_LINKS
           
static String PROPERTY_SHOW_LINKS_FOR_PROTECTED_FIELDS
           
static String PROPERTY_STYLES_FOR_TD
           
static String PROPERTY_TRIM_LINKS
           
static String PROPERTY_USING_MONOSPACE_FONT
           
static String PROPERTY_VERTICAL_SEGMENT_ALIGNMENT
           
protected  boolean readOnly
           
protected  boolean renderProtectedAsLinks
           
protected  boolean trimLinks
           
protected  boolean usingMonoFont
           
protected  boolean verticalSegmentAlignment
           
 
Fields inherited from class com.ibm.hats.transform.widgets.Widget
CLASS_NAME, componentElements, contextAttributes, settings
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
AbstractFieldWidget(ComponentElement[] componentElements, Properties settings)
           
 
Method Summary
protected  String[] getArabicStringSegments(String value)
           
protected static String[] getStringSegments(String value)
          Returns an array of String segments.
protected static String[] getTrimmedLinkSegments(String text)
          Break string into 3 parts leading whitespace, text, and trailing whitespace
protected  boolean isCharacter(char c)
           
 void setSettings(Properties newSettings)
          Sets the Widget's settings.
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, getPropertyPageCount, 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

COPYRIGHT

protected static final String COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

PROPERTY_PRESERVE_COLORS

public static final String PROPERTY_PRESERVE_COLORS
See Also:
Constant Field Values

PROPERTY_MAP_EXTENDED_ATTRIBUTES

public static final String PROPERTY_MAP_EXTENDED_ATTRIBUTES
See Also:
Constant Field Values

PROPERTY_CHARACTER_RENDERING

public static final String PROPERTY_CHARACTER_RENDERING
See Also:
Constant Field Values

PROPERTY_VERTICAL_SEGMENT_ALIGNMENT

public static final String PROPERTY_VERTICAL_SEGMENT_ALIGNMENT
See Also:
Constant Field Values

PROPERTY_OPTIMIZED_OUTPUT

public static final String PROPERTY_OPTIMIZED_OUTPUT
See Also:
Constant Field Values

PROPERTY_READ_ONLY

public static final String PROPERTY_READ_ONLY
See Also:
Constant Field Values

PROPERTY_SHOW_LINKS_FOR_PROTECTED_FIELDS

public static final String PROPERTY_SHOW_LINKS_FOR_PROTECTED_FIELDS
See Also:
Constant Field Values

PROPERTY_RENDER_PROTECTED_TEXT_AS_LINKS

public static final String PROPERTY_RENDER_PROTECTED_TEXT_AS_LINKS
See Also:
Constant Field Values

PROPERTY_AUTO_KEY_FOR_PROTECTED_FIELD_LINKS

public static final String PROPERTY_AUTO_KEY_FOR_PROTECTED_FIELD_LINKS
See Also:
Constant Field Values

PROPERTY_PROTECTED_LINK_STYLE_CLASS

public static final String PROPERTY_PROTECTED_LINK_STYLE_CLASS
See Also:
Constant Field Values

PROPERTY_TRIM_LINKS

public static final String PROPERTY_TRIM_LINKS
See Also:
Constant Field Values

PROPERTY_OMIT_EXTRANEOUS_TABLES

public static final String PROPERTY_OMIT_EXTRANEOUS_TABLES
See Also:
Constant Field Values

PROPERTY_ADD_SPAN_TAGS_TO_TEXT

public static final String PROPERTY_ADD_SPAN_TAGS_TO_TEXT
See Also:
Constant Field Values

PROPERTY_ADD_REVERSE_COLOR_CLASS_TO_TD_TAG

public static final String PROPERTY_ADD_REVERSE_COLOR_CLASS_TO_TD_TAG
See Also:
Constant Field Values

PROPERTY_APPLY_EXTENDED_STYLE_TO_INSIDE_TD_TAG

public static final String PROPERTY_APPLY_EXTENDED_STYLE_TO_INSIDE_TD_TAG
See Also:
Constant Field Values

PROPERTY_APPLY_EXTENDED_STYLE_TO_TD_TAG

public static final String PROPERTY_APPLY_EXTENDED_STYLE_TO_TD_TAG
See Also:
Constant Field Values

PROPERTY_APPLY_UNDERLINE_STYLE_TO_INPUTS

public static final String PROPERTY_APPLY_UNDERLINE_STYLE_TO_INPUTS
See Also:
Constant Field Values

PROPERTY_APPLY_COLUMN_SEPARATOR_STYLE_TO_INPUTS

public static final String PROPERTY_APPLY_COLUMN_SEPARATOR_STYLE_TO_INPUTS
See Also:
Constant Field Values

PROPERTY_ADD_NOWRAP_TO_TD

public static final String PROPERTY_ADD_NOWRAP_TO_TD
See Also:
Constant Field Values

PROPERTY_STYLES_FOR_TD

public static final String PROPERTY_STYLES_FOR_TD
See Also:
Constant Field Values

PROPERTY_CLASSES_FOR_TD

public static final String PROPERTY_CLASSES_FOR_TD
See Also:
Constant Field Values

PROPERTY_FIELD_STYLE_CLASS

public static final String PROPERTY_FIELD_STYLE_CLASS
See Also:
Constant Field Values

PROPERTY_ALIGNMENT

public static final String PROPERTY_ALIGNMENT
See Also:
Constant Field Values

ALIGNMENT_NORMAL

public static final String ALIGNMENT_NORMAL
See Also:
Constant Field Values

ALIGNMENT_CHAR_BY_CHAR

public static final String ALIGNMENT_CHAR_BY_CHAR
See Also:
Constant Field Values

ALIGNMENT_WORD_BY_WORD

public static final String ALIGNMENT_WORD_BY_WORD
See Also:
Constant Field Values

PROPERTY_USING_MONOSPACE_FONT

public static final String PROPERTY_USING_MONOSPACE_FONT
See Also:
Constant Field Values

PROPERTY_ENABLE_NUMERIC_LOCK

public static final String PROPERTY_ENABLE_NUMERIC_LOCK
See Also:
Constant Field Values

PROPERTY_LAYOUT

public static final String PROPERTY_LAYOUT
See Also:
Constant Field Values

LAYOUT_TABLE

public static final String LAYOUT_TABLE
See Also:
Constant Field Values

LAYOUT_SEPARATED

public static final String LAYOUT_SEPARATED
See Also:
Constant Field Values

mapForegroundColors

protected boolean mapForegroundColors

mapExtendedAttributes

protected boolean mapExtendedAttributes

characterRendering

protected boolean characterRendering

verticalSegmentAlignment

protected boolean verticalSegmentAlignment

allowPositionOnProtected

protected boolean allowPositionOnProtected

renderProtectedAsLinks

protected boolean renderProtectedAsLinks

actionKey

protected String actionKey

trimLinks

protected boolean trimLinks

readOnly

protected boolean readOnly

usingMonoFont

protected boolean usingMonoFont
Constructor Detail

AbstractFieldWidget

public AbstractFieldWidget(ComponentElement[] componentElements,
                           Properties settings)
Method Detail

getStringSegments

protected static String[] getStringSegments(String value)
Returns an array of String segments. In the following example, the segments are as follows:
Example: " Will is really, really cool "
Segments: " ", "Will ", "is ", "really, ", and "cool "

Parameters:
value - The String to be segmented.
Returns:
An array of String segments.

getArabicStringSegments

protected String[] getArabicStringSegments(String value)

isCharacter

protected boolean isCharacter(char c)

setSettings

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

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

getTrimmedLinkSegments

protected static String[] getTrimmedLinkSegments(String text)
Break string into 3 parts leading whitespace, text, and trailing whitespace

Parameters:
text -
Returns:
String[] leading, text, and trailing

HATS 7.5.1 (201005110649)