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 TableWidget

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

public class TableWidget
extends AbstractTableWidget
implements HTMLRenderer

TableWidget renders HTML tables from TableComponentElements.

See Also:
TableComponentElement

Field Summary
protected  String arabicOrientation
           
static String CLASS_NAME
           
protected  int codepage
           
static String DEFAULT_LINK_CAPTION
           
static Properties defaults
           
protected  String dir
           
protected  String dirText
           
protected  HTMLElementFactory htmlElementFactory
           
protected  boolean isBIDI
           
protected  boolean isLinuxRuntime
           
protected  boolean isNumericSwapping
           
protected  boolean isSymmetricSwapping
           
static String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
           
protected  boolean reversed
           
protected  String ScreenOrient
           
 
Fields inherited from class com.ibm.hats.transform.widgets.AbstractTableWidget
BUTTON_LAUNCHER, COLLAPSE_ALT_VALUE, COLLAPSE_AREA_CLASS, COLLAPSE_AREA_STYLE, COLLAPSE_CLASS, COLLAPSE_REPRESENTATION, COLLAPSE_STYLE, COLLAPSE_VALUE, COLUMN_BREAK, COMPONENT, CSV_EXT, DEFAULT_BUTTON_STYLE_CLASS, DEFAULT_LINK_STYLE_CLASS, DEFAULT_PREFIX_NAME, DIR_TEXT, DL_COLMUN_BASE_TABLE, DL_FIELD_TABLE, DL_SERVLET_NAME, DL_VISUAL_TABLE, END_COL, END_ROW, EXCLUDE_COLS, EXCLUDE_ROWS, 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, EXTNAME, FILENAME_PREFIX, IMAGE_LAUNCHER, INCLUDE_EMPTY_ROWS, IS_IN_DEFAULT_RENDERING, KEEP_EXPANSION_ON_SERVER, LINK_LAUNCHER, LTR_WIDGET_ORIENTATION, MINIMUM_COLS, MINIMUM_ROWS, NORMAL_COLUMN_LAYOUT, NUMBER_OF_TITLE_ROWS, PORTLET_ID, PROPERTY_BORDER, PROPERTY_BUTTON_STYLE_CLASS, PROPERTY_COLUMN_HEADER_SOURCE, PROPERTY_COLUMN_HEADERS, PROPERTY_FILE_EXTNAME, PROPERTY_FILE_NAME_PREFIX, PROPERTY_HEADER_COLS, PROPERTY_HEADER_ROWS, PROPERTY_HIGHLIGHTED_COLS, PROPERTY_HIGHLIGHTED_ROWS, PROPERTY_LINK_CAPTION, PROPERTY_LINK_STYLE_CLASS, PROPERTY_LINK_TYPE, PROPERTY_PROVIDE_SPREADSHEET_FILE, PROPERTY_READ_ONLY, PROPERTY_SHOW_ALTERNATING_ROW_COLORS, PROPERTY_SHOW_GRID_LINES, PROPERTY_TRIM_HEADERS, RTL_SCREEN, SPREADSHEET_IMAGE, START_COL, START_ROW, TABLE_INDEX, XLS_EXT
 
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
TableWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor.
 
Method Summary
 TableCellComponentElement[][][] brokenCells(com.ibm.hats.common.NumberedSet breaks, TableComponentElement tce)
           
 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)
           
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
 com.ibm.hats.common.NumberedSet findBreaks(TableComponentElement tce)
           
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle, boolean isInScreenCombination)
           
 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.
 String printDecodeTCCEaaa(TableCellComponentElement[][][] tcce, String label)
           
 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)
           
 void renderExpansionRepresentation(StringBuffer buffer, Properties settings, String id, String cellStyleClass, String style, boolean keepExpansionOnServer)
           
 void renderExpansionRepresentationHeader(StringBuffer buffer, Properties settings, String cellStyleClass, String style)
           
 void renderTableCell(StringBuffer buffer, TableCellComponentElement tcce, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 void renderTableDataCells(StringBuffer buffer, TableCellComponentElement[] tccea, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 void renderTableDataSpan(StringBuffer buffer, TableCellComponentElement tcce, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 void renderTableHeaderCell(StringBuffer buffer, TableCellComponentElement tcce, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 void renderTableHeaderCells(StringBuffer buffer, TableCellComponentElement[] tccea, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 void renderTableHeaderSpan(StringBuffer buffer, TableCellComponentElement tcce, int col, String headerRowStyleClass, String cellStyleClass, String style, boolean isHeaderCol, boolean readOnly, boolean isHeaderRow, boolean trimHeaders)
           
 
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
See Also:
Constant Field Values

DEFAULT_LINK_CAPTION

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

defaults

public static Properties defaults

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

codepage

protected int codepage

isBIDI

protected boolean isBIDI

dir

protected String dir

dirText

protected String dirText

reversed

protected boolean reversed

isSymmetricSwapping

protected boolean isSymmetricSwapping

isNumericSwapping

protected boolean isNumericSwapping

arabicOrientation

protected String arabicOrientation

ScreenOrient

protected String ScreenOrient

isLinuxRuntime

protected boolean isLinuxRuntime
Constructor Detail

TableWidget

public TableWidget(ComponentElement[] componentElement,
                   Properties settings)
Class constructor.

Parameters:
componentElement -
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

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

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

getCustomProperties

public Vector getCustomProperties(int iPageNumber,
                                  Properties properties,
                                  ResourceBundle bundle,
                                  boolean isInScreenCombination)
Specified by:
getCustomProperties in class AbstractTableWidget

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

renderTableHeaderCells

public void renderTableHeaderCells(StringBuffer buffer,
                                   TableCellComponentElement[] tccea,
                                   int col,
                                   String headerRowStyleClass,
                                   String cellStyleClass,
                                   String style,
                                   boolean isHeaderCol,
                                   boolean readOnly,
                                   boolean isHeaderRow,
                                   boolean trimHeaders)

renderTableHeaderSpan

public void renderTableHeaderSpan(StringBuffer buffer,
                                  TableCellComponentElement tcce,
                                  int col,
                                  String headerRowStyleClass,
                                  String cellStyleClass,
                                  String style,
                                  boolean isHeaderCol,
                                  boolean readOnly,
                                  boolean isHeaderRow,
                                  boolean trimHeaders)

renderTableHeaderCell

public void renderTableHeaderCell(StringBuffer buffer,
                                  TableCellComponentElement tcce,
                                  int col,
                                  String headerRowStyleClass,
                                  String cellStyleClass,
                                  String style,
                                  boolean isHeaderCol,
                                  boolean readOnly,
                                  boolean isHeaderRow,
                                  boolean trimHeaders)

renderTableDataCells

public void renderTableDataCells(StringBuffer buffer,
                                 TableCellComponentElement[] tccea,
                                 int col,
                                 String headerRowStyleClass,
                                 String cellStyleClass,
                                 String style,
                                 boolean isHeaderCol,
                                 boolean readOnly,
                                 boolean isHeaderRow,
                                 boolean trimHeaders)

renderTableDataSpan

public void renderTableDataSpan(StringBuffer buffer,
                                TableCellComponentElement tcce,
                                int col,
                                String headerRowStyleClass,
                                String cellStyleClass,
                                String style,
                                boolean isHeaderCol,
                                boolean readOnly,
                                boolean isHeaderRow,
                                boolean trimHeaders)

renderTableCell

public void renderTableCell(StringBuffer buffer,
                            TableCellComponentElement tcce,
                            int col,
                            String headerRowStyleClass,
                            String cellStyleClass,
                            String style,
                            boolean isHeaderCol,
                            boolean readOnly,
                            boolean isHeaderRow,
                            boolean trimHeaders)

renderExpansionRepresentationHeader

public void renderExpansionRepresentationHeader(StringBuffer buffer,
                                                Properties settings,
                                                String cellStyleClass,
                                                String style)

renderExpansionRepresentation

public void renderExpansionRepresentation(StringBuffer buffer,
                                          Properties settings,
                                          String id,
                                          String cellStyleClass,
                                          String style,
                                          boolean keepExpansionOnServer)

renderExpandableAreaForRow

public 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)

findBreaks

public com.ibm.hats.common.NumberedSet findBreaks(TableComponentElement tce)

printDecodeTCCEaaa

public String printDecodeTCCEaaa(TableCellComponentElement[][][] tcce,
                                 String label)

brokenCells

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

createExpansionTableContents

public 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)

HATS 7.5.1 (201005110649)