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 AbstractSubfileWidget

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

public class AbstractSubfileWidget
extends AbstractFieldWidget
implements SubfileWidgetConstants


Field Summary
protected  ComponentElement[] actionComponentElements
           
static String BUTTON_LAUNCHER
           
protected  String captionType
           
protected  ComponentElementList cel
           
protected  int codepage
           
static String COLLAPSE_ALT_VALUE
           
static String COLLAPSE_AREA_CLASS
           
static String COLLAPSE_AREA_STYLE
           
static String COLLAPSE_CLASS
           
static String COLLAPSE_REPRESENTATION
           
static String COLLAPSE_STYLE
           
static String COLLAPSE_VALUE
           
static Properties defaults
           
static String EXPAND_ALT_VALUE
           
static String EXPAND_AREA_CLASS
           
static String EXPAND_AREA_STYLE
           
static String EXPAND_CLASS
           
static String EXPAND_HEADER_CLASS
           
static String EXPAND_HEADER_STYLE
           
static String EXPAND_HEADER_VALUE
           
static String EXPAND_REPRESENTATION
           
static String EXPAND_ROW_CLASS
           
static String EXPAND_ROW_STYLE
           
static String EXPAND_STYLE
           
static String EXPAND_VALUE
           
static String EXTENDED_COLUMN_LAYOUT
           
static String IMAGE_LAUNCHER
           
protected  boolean isColumnBasedTable
           
protected  boolean isDBCSSession
           
protected  boolean isFieldTable
           
protected  boolean isTableComponent
           
protected  boolean isVisualTable
           
static String KEEP_EXPANSION_ON_SERVER
           
static String LINK_LAUNCHER
           
static String NORMAL_COLUMN_LAYOUT
           
protected  int numberOfRowsPerRecord
           
protected  String recognitionOption
           
protected  int subfileActionEndRow
           
protected  int subfileHeaderEndRow
           
protected  boolean subfileShowActions
           
protected  boolean useAccentedCharacters
           
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractFieldWidget
actionKey, ALIGNMENT_CHAR_BY_CHAR, ALIGNMENT_NORMAL, ALIGNMENT_WORD_BY_WORD, allowPositionOnProtected, characterRendering, LAYOUT_SEPARATED, LAYOUT_TABLE, mapExtendedAttributes, mapForegroundColors, PROPERTY_ADD_NOWRAP_TO_TD, PROPERTY_ADD_REVERSE_COLOR_CLASS_TO_TD_TAG, PROPERTY_ADD_SPAN_TAGS_TO_TEXT, PROPERTY_ALIGNMENT, PROPERTY_APPLY_COLUMN_SEPARATOR_STYLE_TO_INPUTS, PROPERTY_APPLY_EXTENDED_STYLE_TO_INSIDE_TD_TAG, PROPERTY_APPLY_EXTENDED_STYLE_TO_TD_TAG, PROPERTY_APPLY_UNDERLINE_STYLE_TO_INPUTS, PROPERTY_AUTO_KEY_FOR_PROTECTED_FIELD_LINKS, PROPERTY_CHARACTER_RENDERING, PROPERTY_CLASSES_FOR_TD, PROPERTY_ENABLE_NUMERIC_LOCK, PROPERTY_FIELD_STYLE_CLASS, PROPERTY_LAYOUT, PROPERTY_MAP_EXTENDED_ATTRIBUTES, PROPERTY_OMIT_EXTRANEOUS_TABLES, PROPERTY_OPTIMIZED_OUTPUT, PROPERTY_PRESERVE_COLORS, PROPERTY_PROTECTED_LINK_STYLE_CLASS, PROPERTY_READ_ONLY, PROPERTY_RENDER_PROTECTED_TEXT_AS_LINKS, PROPERTY_SHOW_LINKS_FOR_PROTECTED_FIELDS, PROPERTY_STYLES_FOR_TD, PROPERTY_TRIM_LINKS, PROPERTY_USING_MONOSPACE_FONT, PROPERTY_VERTICAL_SEGMENT_ALIGNMENT, readOnly, renderProtectedAsLinks, trimLinks, usingMonoFont, verticalSegmentAlignment
 
Fields inherited from class com.ibm.hats.transform.widgets.Widget
CLASS_NAME, componentElements, contextAttributes, settings
 
Fields inherited from interface com.ibm.hats.transform.widgets.SubfileWidgetConstants
CAPTION_TYPE_BUTTON, CAPTION_TYPE_LINK, LOCATION_TYPE_ABOVE, LOCATION_TYPE_BELOW, LOCATION_TYPE_BOTH, PROPERTY_ACTIONS_LOCATION, PROPERTY_ACTIONS_TYPE, PROPERTY_AUTOSUBMIT, PROPERTY_CAPTION_TYPE, PROPERTY_SHOW_SUBMIT_BUTTON, PROPERTY_SUBFILE_NUMBER_OF_ROWS_PER_RECORD, PROPERTY_SUBFILE_SHOW_ACTIONS, PROPERTY_SUBMIT_BUTTON_CAPTION, TABLE_COMPONENT_CLASS_NAME_FIELD, TABLE_COMPONENT_CLASS_NAME_NONE, TABLE_COMPONENT_CLASS_NAME_TABLE, TABLE_COMPONENT_CLASS_NAME_VISUAL
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
AbstractSubfileWidget(ComponentElement[] componentElements, Properties settings)
           
 
Method Summary
 void setComponentElements(ComponentElement[] newElements)
          Sets the component element array
 void setContextAttributes(ContextAttributes contextAttributes)
          Sets the context attributes
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractFieldWidget
getArabicStringSegments, getStringSegments, getTrimmedLinkSegments, isCharacter, setSettings
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, getPropertyPageCount, getSettings, insertAlign, insertDir, newInstance, setContextAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORMAL_COLUMN_LAYOUT

public static final String NORMAL_COLUMN_LAYOUT
See Also:
Constant Field Values

EXTENDED_COLUMN_LAYOUT

public static final String EXTENDED_COLUMN_LAYOUT
See Also:
Constant Field Values

KEEP_EXPANSION_ON_SERVER

public static final String KEEP_EXPANSION_ON_SERVER
See Also:
Constant Field Values

EXPAND_HEADER_VALUE

public static final String EXPAND_HEADER_VALUE
See Also:
Constant Field Values

EXPAND_HEADER_STYLE

public static final String EXPAND_HEADER_STYLE
See Also:
Constant Field Values

EXPAND_HEADER_CLASS

public static final String EXPAND_HEADER_CLASS
See Also:
Constant Field Values

EXPAND_REPRESENTATION

public static final String EXPAND_REPRESENTATION
See Also:
Constant Field Values

EXPAND_VALUE

public static final String EXPAND_VALUE
See Also:
Constant Field Values

EXPAND_ALT_VALUE

public static final String EXPAND_ALT_VALUE
See Also:
Constant Field Values

EXPAND_STYLE

public static final String EXPAND_STYLE
See Also:
Constant Field Values

EXPAND_CLASS

public static final String EXPAND_CLASS
See Also:
Constant Field Values

EXPAND_AREA_STYLE

public static final String EXPAND_AREA_STYLE
See Also:
Constant Field Values

EXPAND_AREA_CLASS

public static final String EXPAND_AREA_CLASS
See Also:
Constant Field Values

EXPAND_ROW_STYLE

public static final String EXPAND_ROW_STYLE
See Also:
Constant Field Values

EXPAND_ROW_CLASS

public static final String EXPAND_ROW_CLASS
See Also:
Constant Field Values

COLLAPSE_REPRESENTATION

public static final String COLLAPSE_REPRESENTATION
See Also:
Constant Field Values

COLLAPSE_VALUE

public static final String COLLAPSE_VALUE
See Also:
Constant Field Values

COLLAPSE_ALT_VALUE

public static final String COLLAPSE_ALT_VALUE
See Also:
Constant Field Values

COLLAPSE_STYLE

public static final String COLLAPSE_STYLE
See Also:
Constant Field Values

COLLAPSE_CLASS

public static final String COLLAPSE_CLASS
See Also:
Constant Field Values

COLLAPSE_AREA_STYLE

public static final String COLLAPSE_AREA_STYLE
See Also:
Constant Field Values

COLLAPSE_AREA_CLASS

public static final String COLLAPSE_AREA_CLASS
See Also:
Constant Field Values

LINK_LAUNCHER

public static final String LINK_LAUNCHER
See Also:
Constant Field Values

IMAGE_LAUNCHER

public static final String IMAGE_LAUNCHER
See Also:
Constant Field Values

BUTTON_LAUNCHER

public static final String BUTTON_LAUNCHER
See Also:
Constant Field Values

defaults

public static Properties defaults

codepage

protected int codepage

isDBCSSession

protected boolean isDBCSSession

useAccentedCharacters

protected boolean useAccentedCharacters

cel

protected ComponentElementList cel

actionComponentElements

protected ComponentElement[] actionComponentElements

captionType

protected String captionType

subfileShowActions

protected boolean subfileShowActions

numberOfRowsPerRecord

protected int numberOfRowsPerRecord

isTableComponent

protected boolean isTableComponent

isVisualTable

protected boolean isVisualTable

isFieldTable

protected boolean isFieldTable

isColumnBasedTable

protected boolean isColumnBasedTable

recognitionOption

protected String recognitionOption

subfileHeaderEndRow

protected int subfileHeaderEndRow

subfileActionEndRow

protected int subfileActionEndRow
Constructor Detail

AbstractSubfileWidget

public AbstractSubfileWidget(ComponentElement[] componentElements,
                             Properties settings)
Parameters:
componentElements -
settings -
Method Detail

setComponentElements

public void setComponentElements(ComponentElement[] newElements)
Sets the component element array

Overrides:
setComponentElements in class Widget
Parameters:
newElements - An array of ComponentElement to set

setContextAttributes

public void setContextAttributes(ContextAttributes contextAttributes)
Sets the context attributes

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

HATS 7.5.1 (201005110649)