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 SubfileCheckboxWidget

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

public class SubfileCheckboxWidget
extends SubfileWidgetV6
implements HTMLRenderer, IContextDependent


Field Summary
static String CLASS_NAME
           
static Properties defaults
           
static String PROPERTY_CHECKBOX_STYLE_CLASS
           
static String PROPERTY_LINK_STYLE_CLASS
           
 
Fields inherited from class com.ibm.hats.transform.widgets.SubfileWidgetV6
actionInputFieldIndex, actionInputFieldLength, actionInputFieldStartCol, addNowrap, arabicOrientation, blinkStyle, cellStyleClass, colspan, columnCount, columnSeparatorStyle, dataSplitIndex, dir, dirAttribute, dirMarker, evenRowStyleClass, extendedStyle, fieldStyleClass, FONT_FAMILY_MONOSPACE, foregroundColorStyleClass, headerEndRow, headerRowStyleClass, headerStartRow, htmlElementFactory, isBIDI, isNumericSwapping, isRenderTable, isReordered, isSymmetricSwapping, markerStartPos, maxColspan, NO_BORDER, NO_LEFT_BORDER, NO_PADDING, NO_RIGHT_BORDER, NO_WRAP, oddRowStyleClass, order, PROPERTY_BLINK_STYLE, PROPERTY_BUTTON_ROW_STYLE_CLASS, PROPERTY_BUTTON_STYLE_CLASS, PROPERTY_COLUMN_SEPARATOR_STYLE, PROPERTY_EVEN_ROW_STYLE_CLASS, PROPERTY_FIELD_TEXT_ALIGNMENT, PROPERTY_HEADER_ROW_STYLE_CLASS, PROPERTY_ODD_ROW_STYLE_CLASS, PROPERTY_OPTION_STYLE_CLASS, PROPERTY_REVERSE_VIDEO_STYLE, PROPERTY_SELECT_STYLE_CLASS, PROPERTY_TABLE_CELL_STYLE_CLASS, PROPERTY_TABLE_STYLE_CLASS, PROPERTY_UNDERLINE_STYLE, PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION, regionEndCol, regionStartCol, reorderedColumnCount, reverseColorStyleClass, reverseVideoStyle, rowNum, rowStyleClass, screenOrientation, SPACE_CHARACTER, style, subfileIncludeEmptyRows, table, tableCellStyleClass, tableStyleClass, td, th, tr, underlineStyle, 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
SubfileCheckboxWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
protected  void drawAction(SubfileActionComponentElementV6 sace, StringBuffer buffer, HTMLElement cellElement)
          Draw Subfile action cell
protected  void drawActionElement(ListItemComponentElement lice, StringBuffer buffer)
          Draw Subfile action button or link
protected  void drawActionField(FieldComponentElement fce, ComponentElementList cel, String captionType, StringBuffer buffer)
          Draw Subfile checkbox action field
protected  void drawCheckbox(FieldComponentElement fce, ComponentElementList cel, String captionType, StringBuffer buffer, String checkboxStyleClass)
           
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
 
Methods inherited from class com.ibm.hats.transform.widgets.SubfileWidgetV6
brokenCells, compositeDrawSubfileData, compositeDrawSubfileHeaders, compositeDrawSubfileMarkers, correctDataSplitIndices, createColumnBasedTableDataExpansionRow, createExpansionTableContents, drawField, findBreaks, rearrangeExtensionColumnOutput, rearrangeNonExtensionColumnOutput, renderColumnBasedTableExpandableAreaForRow, renderExpandableAreaForRow, renderExpansionRepresentation, renderExpansionRepresentationHeader, setupColumns, superSetDataSplitIndices
 
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_LINK_STYLE_CLASS

public static final String PROPERTY_LINK_STYLE_CLASS

PROPERTY_CHECKBOX_STYLE_CLASS

public static final String PROPERTY_CHECKBOX_STYLE_CLASS

defaults

public static Properties defaults
Constructor Detail

SubfileCheckboxWidget

public SubfileCheckboxWidget(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
Overrides:
drawHTML in class SubfileWidgetV6
Returns:
HTML output

drawAction

protected void drawAction(SubfileActionComponentElementV6 sace,
                          StringBuffer buffer,
                          HTMLElement cellElement)
Draw Subfile action cell

Parameters:
sace - Subfile action component element
buffer - String buffer
cellElement - HTML cell element

drawActionElement

protected void drawActionElement(ListItemComponentElement lice,
                                 StringBuffer buffer)
Draw Subfile action button or link

Parameters:
lice - ListItem component element
buffer - String buffer

drawCheckbox

protected void drawCheckbox(FieldComponentElement fce,
                            ComponentElementList cel,
                            String captionType,
                            StringBuffer buffer,
                            String checkboxStyleClass)

drawActionField

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

Overrides:
drawActionField in class SubfileWidgetV6
Parameters:
fce - Filed component element
cel - A list of component elements
captionType - Caption type
buffer - String buffer
See Also:
SubfileWidgetV6.drawActionField(FieldComponentElement, ComponentElementList, String, StringBuffer)

HATS 7.5.1 (201005110649)