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 SubfileWidgetV6

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
              extended by com.ibm.hats.transform.widgets.SubfileWidgetV6
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier, HTMLRenderer, com.ibm.hats.transform.renderers.TextRenderer, SubfileWidgetConstants
Direct Known Subclasses:
SubfileCheckboxWidget, SubfilePopupWidget

public class SubfileWidgetV6
extends AbstractSubfileWidget
implements HTMLRenderer, IContextDependent

SubfileWidget renders HTML for Subfile elements from ComponentElementList

Please refer to the User's Guide for detail on this Widget's settings.

See Also:
ComponentElementList

Field Summary
protected  HashSet actionInputFieldIndex
           
protected  int actionInputFieldLength
           
protected  int actionInputFieldStartCol
           
protected  boolean addNowrap
           
protected  String arabicOrientation
           
protected  String blinkStyle
           
protected  String cellStyleClass
           
static String CLASS_NAME
           
protected  int colspan
           
protected  int columnCount
           
protected  String columnSeparatorStyle
           
protected  TreeSet dataSplitIndex
           
static Properties defaults
           
protected  String dir
           
protected  String dirAttribute
           
protected  String dirMarker
           
protected  String evenRowStyleClass
           
protected  String extendedStyle
           
protected  String fieldStyleClass
           
protected  String FONT_FAMILY_MONOSPACE
           
protected  String foregroundColorStyleClass
           
protected  int headerEndRow
           
protected  String headerRowStyleClass
           
protected  int headerStartRow
           
protected  HTMLElementFactory htmlElementFactory
           
protected  boolean isBIDI
           
protected  boolean isNumericSwapping
           
protected  boolean isRenderTable
           
protected  boolean isReordered
           
protected  boolean isSymmetricSwapping
           
protected  int markerStartPos
           
protected  int maxColspan
           
protected  String NO_BORDER
           
protected  String NO_LEFT_BORDER
           
protected  String NO_PADDING
           
protected  String NO_RIGHT_BORDER
           
protected  String NO_WRAP
           
protected  String oddRowStyleClass
           
protected  com.ibm.hats.common.SectionedNumberedSet order
           
static String PROPERTY_BLINK_STYLE
           
static String PROPERTY_BUTTON_ROW_STYLE_CLASS
           
static String PROPERTY_BUTTON_STYLE_CLASS
           
static String PROPERTY_COLUMN_SEPARATOR_STYLE
           
static String PROPERTY_EVEN_ROW_STYLE_CLASS
           
static String PROPERTY_FIELD_TEXT_ALIGNMENT
           
static String PROPERTY_HEADER_ROW_STYLE_CLASS
           
static String PROPERTY_ODD_ROW_STYLE_CLASS
           
static String PROPERTY_OPTION_STYLE_CLASS
           
static String PROPERTY_REVERSE_VIDEO_STYLE
           
static String PROPERTY_SELECT_STYLE_CLASS
           
static String PROPERTY_TABLE_CELL_STYLE_CLASS
           
static String PROPERTY_TABLE_STYLE_CLASS
           
static String PROPERTY_UNDERLINE_STYLE
           
static String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
           
protected  int regionEndCol
           
protected  int regionStartCol
           
protected  int reorderedColumnCount
           
protected  String reverseColorStyleClass
           
protected  String reverseVideoStyle
           
protected  int rowNum
           
protected  String rowStyleClass
           
protected  String screenOrientation
           
protected  String SPACE_CHARACTER
           
protected  String style
           
protected  boolean subfileIncludeEmptyRows
           
protected  HTMLElement table
           
protected  String tableCellStyleClass
           
protected  String tableStyleClass
           
protected  HTMLElement td
           
protected  HTMLElement th
           
protected  HTMLElement tr
           
protected  String underlineStyle
           
protected  ComponentElement workingElement
           
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractSubfileWidget
actionComponentElements, BUTTON_LAUNCHER, captionType, cel, codepage, COLLAPSE_ALT_VALUE, COLLAPSE_AREA_CLASS, COLLAPSE_AREA_STYLE, COLLAPSE_CLASS, COLLAPSE_REPRESENTATION, COLLAPSE_STYLE, COLLAPSE_VALUE, EXPAND_ALT_VALUE, EXPAND_AREA_CLASS, EXPAND_AREA_STYLE, EXPAND_CLASS, EXPAND_HEADER_CLASS, EXPAND_HEADER_STYLE, EXPAND_HEADER_VALUE, EXPAND_REPRESENTATION, EXPAND_ROW_CLASS, EXPAND_ROW_STYLE, EXPAND_STYLE, EXPAND_VALUE, EXTENDED_COLUMN_LAYOUT, IMAGE_LAUNCHER, isColumnBasedTable, isDBCSSession, isFieldTable, isTableComponent, isVisualTable, KEEP_EXPANSION_ON_SERVER, LINK_LAUNCHER, NORMAL_COLUMN_LAYOUT, numberOfRowsPerRecord, recognitionOption, subfileActionEndRow, subfileHeaderEndRow, subfileShowActions, 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
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
SubfileWidgetV6(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
protected  TableCellComponentElement[][][] brokenCells(com.ibm.hats.common.NumberedSet breaks, TableComponentElement tce)
           
protected  void compositeDrawSubfileData(StringBuffer buffer)
           
protected  void compositeDrawSubfileHeaders(StringBuffer buffer)
           
protected  void compositeDrawSubfileMarkers(StringBuffer buffer)
           
protected  TreeSet correctDataSplitIndices(FieldRowComponentElement frce, TreeSet dSI)
           
protected  void createColumnBasedTableDataExpansionRow(FieldComponentElement[][] fcea, StringBuffer buffer, com.ibm.hats.common.SectionedNumberedSet order)
           
protected  void createExpansionTableContents(StringBuffer buffer, TableCellComponentElement[][][] headerList, TableCellComponentElement[][][] dataList, int row, com.ibm.hats.common.NumberedSet order, String headerRowStyleClass, String cellStyleClass, String style, int border, com.ibm.hats.common.NumberedSet headerColumns, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
protected  void drawActionField(FieldComponentElement fce, ComponentElementList cel, String captionType, StringBuffer buffer)
          Draw Subfile action field
protected  void drawField(FieldComponentElement fce, StringBuffer buffer, HTMLElement cellElement, boolean isHeader)
          Draw filed into table cell
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  com.ibm.hats.common.NumberedSet findBreaks(TableComponentElement[] tcearray)
           
protected  void rearrangeExtensionColumnOutput(FieldComponentElement[][] dataaa, FieldComponentElement[][][] headeraaa, StringBuffer buffer, com.ibm.hats.common.SectionedNumberedSet order)
           
protected  void rearrangeNonExtensionColumnOutput(FieldComponentElement[][] fceaa, StringBuffer buffer, com.ibm.hats.common.SectionedNumberedSet order, boolean isHeader)
           
protected  void renderColumnBasedTableExpandableAreaForRow(FieldComponentElement[][] fcea, StringBuffer buffer, com.ibm.hats.common.SectionedNumberedSet order, String id, boolean keepExpansionOnServer)
           
protected  void renderExpandableAreaForRow(StringBuffer buffer, Properties settings, com.ibm.hats.common.SectionedNumberedSet colLayout, TableCellComponentElement[][][] headerList, TableCellComponentElement[][][] dataList, int row, String id, boolean isHeaderRow, String rowStyleClass, String headerRowStyleClass, String cellStyleClass, com.ibm.hats.common.NumberedSet headerColumns, String style, int border, boolean readOnly, boolean trimHeaders, boolean keepExpansionOnServer)
           
protected  void renderExpansionRepresentation(StringBuffer buffer, String id, String cellStyleClass, String style, boolean keepExpansionOnServer)
           
protected  void renderExpansionRepresentationHeader(StringBuffer buffer, String cellStyleClass, String style)
           
protected  FieldComponentElement[][] setupColumns(FieldRowComponentElement frce)
           
protected  TreeSet superSetDataSplitIndices(SubfileHeaderComponentElementV6[] shcea)
           
 
Methods inherited from class com.ibm.hats.transform.widgets.AbstractSubfileWidget
setComponentElements, setContextAttributes
 
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
 
Methods inherited from interface com.ibm.hats.common.IContextDependent
isAllowed, isPropertyAllowed
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values

PROPERTY_TABLE_STYLE_CLASS

public static final String PROPERTY_TABLE_STYLE_CLASS

PROPERTY_TABLE_CELL_STYLE_CLASS

public static final String PROPERTY_TABLE_CELL_STYLE_CLASS

PROPERTY_HEADER_ROW_STYLE_CLASS

public static final String PROPERTY_HEADER_ROW_STYLE_CLASS

PROPERTY_ODD_ROW_STYLE_CLASS

public static final String PROPERTY_ODD_ROW_STYLE_CLASS

PROPERTY_EVEN_ROW_STYLE_CLASS

public static final String PROPERTY_EVEN_ROW_STYLE_CLASS

PROPERTY_BUTTON_STYLE_CLASS

public static final String PROPERTY_BUTTON_STYLE_CLASS

PROPERTY_FIELD_TEXT_ALIGNMENT

public static final String PROPERTY_FIELD_TEXT_ALIGNMENT
See Also:
Constant Field Values

PROPERTY_SELECT_STYLE_CLASS

public static final String PROPERTY_SELECT_STYLE_CLASS

PROPERTY_OPTION_STYLE_CLASS

public static final String PROPERTY_OPTION_STYLE_CLASS

PROPERTY_BUTTON_ROW_STYLE_CLASS

public static final String PROPERTY_BUTTON_ROW_STYLE_CLASS
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

PROPERTY_BLINK_STYLE

public static final String PROPERTY_BLINK_STYLE
See Also:
Constant Field Values

PROPERTY_REVERSE_VIDEO_STYLE

public static final String PROPERTY_REVERSE_VIDEO_STYLE
See Also:
Constant Field Values

PROPERTY_UNDERLINE_STYLE

public static final String PROPERTY_UNDERLINE_STYLE
See Also:
Constant Field Values

PROPERTY_COLUMN_SEPARATOR_STYLE

public static final String PROPERTY_COLUMN_SEPARATOR_STYLE
See Also:
Constant Field Values

blinkStyle

protected String blinkStyle

underlineStyle

protected String underlineStyle

reverseVideoStyle

protected String reverseVideoStyle

columnSeparatorStyle

protected String columnSeparatorStyle

fieldStyleClass

protected String fieldStyleClass

style

protected String style

addNowrap

protected boolean addNowrap

tableCellStyleClass

protected String tableCellStyleClass

tableStyleClass

protected String tableStyleClass

cellStyleClass

protected String cellStyleClass

headerRowStyleClass

protected String headerRowStyleClass

oddRowStyleClass

protected String oddRowStyleClass

evenRowStyleClass

protected String evenRowStyleClass

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

table

protected HTMLElement table

td

protected HTMLElement td

tr

protected HTMLElement tr

th

protected HTMLElement th

regionStartCol

protected int regionStartCol

regionEndCol

protected int regionEndCol

actionInputFieldStartCol

protected int actionInputFieldStartCol

actionInputFieldLength

protected int actionInputFieldLength

headerStartRow

protected int headerStartRow

headerEndRow

protected int headerEndRow

maxColspan

protected int maxColspan

colspan

protected int colspan

columnCount

protected int columnCount

actionInputFieldIndex

protected HashSet actionInputFieldIndex

dataSplitIndex

protected TreeSet dataSplitIndex

markerStartPos

protected int markerStartPos

rowNum

protected int rowNum

subfileIncludeEmptyRows

protected boolean subfileIncludeEmptyRows

workingElement

protected ComponentElement workingElement

isReordered

protected boolean isReordered

order

protected com.ibm.hats.common.SectionedNumberedSet order

reorderedColumnCount

protected int reorderedColumnCount

NO_BORDER

protected String NO_BORDER

NO_LEFT_BORDER

protected String NO_LEFT_BORDER

NO_RIGHT_BORDER

protected String NO_RIGHT_BORDER

NO_PADDING

protected String NO_PADDING

NO_WRAP

protected String NO_WRAP

FONT_FAMILY_MONOSPACE

protected String FONT_FAMILY_MONOSPACE

SPACE_CHARACTER

protected String SPACE_CHARACTER

isRenderTable

protected boolean isRenderTable

isBIDI

protected boolean isBIDI

dirMarker

protected String dirMarker

isSymmetricSwapping

protected boolean isSymmetricSwapping

isNumericSwapping

protected boolean isNumericSwapping

arabicOrientation

protected String arabicOrientation

screenOrientation

protected String screenOrientation

dir

protected String dir

dirAttribute

protected String dirAttribute

foregroundColorStyleClass

protected String foregroundColorStyleClass

reverseColorStyleClass

protected String reverseColorStyleClass

extendedStyle

protected String extendedStyle

rowStyleClass

protected String rowStyleClass

defaults

public static Properties defaults
Constructor Detail

SubfileWidgetV6

public SubfileWidgetV6(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

correctDataSplitIndices

protected TreeSet correctDataSplitIndices(FieldRowComponentElement frce,
                                          TreeSet dSI)

superSetDataSplitIndices

protected TreeSet superSetDataSplitIndices(SubfileHeaderComponentElementV6[] shcea)

compositeDrawSubfileHeaders

protected void compositeDrawSubfileHeaders(StringBuffer buffer)

compositeDrawSubfileData

protected void compositeDrawSubfileData(StringBuffer buffer)

compositeDrawSubfileMarkers

protected void compositeDrawSubfileMarkers(StringBuffer buffer)

drawActionField

protected void drawActionField(FieldComponentElement fce,
                               ComponentElementList cel,
                               String captionType,
                               StringBuffer buffer)
Draw Subfile action field

Parameters:
fce - Filed component element
cel - A list of component elements
captionType - Caption type
buffer - String buffer

createColumnBasedTableDataExpansionRow

protected void createColumnBasedTableDataExpansionRow(FieldComponentElement[][] fcea,
                                                      StringBuffer buffer,
                                                      com.ibm.hats.common.SectionedNumberedSet order)

renderColumnBasedTableExpandableAreaForRow

protected void renderColumnBasedTableExpandableAreaForRow(FieldComponentElement[][] fcea,
                                                          StringBuffer buffer,
                                                          com.ibm.hats.common.SectionedNumberedSet order,
                                                          String id,
                                                          boolean keepExpansionOnServer)

rearrangeNonExtensionColumnOutput

protected void rearrangeNonExtensionColumnOutput(FieldComponentElement[][] fceaa,
                                                 StringBuffer buffer,
                                                 com.ibm.hats.common.SectionedNumberedSet order,
                                                 boolean isHeader)

rearrangeExtensionColumnOutput

protected void rearrangeExtensionColumnOutput(FieldComponentElement[][] dataaa,
                                              FieldComponentElement[][][] headeraaa,
                                              StringBuffer buffer,
                                              com.ibm.hats.common.SectionedNumberedSet order)

renderExpansionRepresentation

protected void renderExpansionRepresentation(StringBuffer buffer,
                                             String id,
                                             String cellStyleClass,
                                             String style,
                                             boolean keepExpansionOnServer)

renderExpansionRepresentationHeader

protected void renderExpansionRepresentationHeader(StringBuffer buffer,
                                                   String cellStyleClass,
                                                   String style)

renderExpandableAreaForRow

protected void renderExpandableAreaForRow(StringBuffer buffer,
                                          Properties settings,
                                          com.ibm.hats.common.SectionedNumberedSet colLayout,
                                          TableCellComponentElement[][][] headerList,
                                          TableCellComponentElement[][][] dataList,
                                          int row,
                                          String id,
                                          boolean isHeaderRow,
                                          String rowStyleClass,
                                          String headerRowStyleClass,
                                          String cellStyleClass,
                                          com.ibm.hats.common.NumberedSet headerColumns,
                                          String style,
                                          int border,
                                          boolean readOnly,
                                          boolean trimHeaders,
                                          boolean keepExpansionOnServer)

createExpansionTableContents

protected void createExpansionTableContents(StringBuffer buffer,
                                            TableCellComponentElement[][][] headerList,
                                            TableCellComponentElement[][][] dataList,
                                            int row,
                                            com.ibm.hats.common.NumberedSet order,
                                            String headerRowStyleClass,
                                            String cellStyleClass,
                                            String style,
                                            int border,
                                            com.ibm.hats.common.NumberedSet headerColumns,
                                            boolean readOnly,
                                            boolean isHeaderRow,
                                            boolean trimHeaders)

setupColumns

protected FieldComponentElement[][] setupColumns(FieldRowComponentElement frce)

findBreaks

protected com.ibm.hats.common.NumberedSet findBreaks(TableComponentElement[] tcearray)

brokenCells

protected TableCellComponentElement[][][] brokenCells(com.ibm.hats.common.NumberedSet breaks,
                                                      TableComponentElement tce)

drawField

protected void drawField(FieldComponentElement fce,
                         StringBuffer buffer,
                         HTMLElement cellElement,
                         boolean isHeader)
Draw filed into table cell

Parameters:
fce - Field component element
buffer - String buffer
cellElement - HTML cell element
isHeader - Draw field in Subfile header or not

HATS 7.5.1 (201005110649)