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 DialogWidget

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

public class DialogWidget
extends BasicDialogWidget

DialogWidget renders HTML for DisabledAreaComponentElements and DialogRowComponentElements created by the DialogComponent.

PropertyDescriptionTypeDefault Value
borderClassCSS class to use for the borderString
disabledClassCSS class to use for the disabled areaStringHDF
leftBorderStyleCSS style to use for the left borderString
rightBorderStyleCSS style to use for the right borderString
borderHeaderStyleCSS style to use for the top borderString
borderFooterStyleCSS style to use for the bottom borderString
borderTLCornerStyleCSS style to use for the border corner in the top leftString
borderTRCornerStyleCSS style to use for the border corner in the top rightString
borderBLCornerStyleCSS style to use for the border corner in the bottom leftString
borderBRCornerStyleCSS style to use for the border corner in the bottom rightString
specialBordersWhether or not to use specialized borders instead of the original textBooleantrue
removeBorderCharactersWhether or not to show the original border charactersBooleanfalse
removeDisabledCharactersWhether or not to show the area outside of the dialogBooleantrue

See Also:
DialogComponent, DialogRowComponentElement, DisabledAreaComponentElement

Field Summary
 
Fields inherited from class com.ibm.hats.transform.widgets.BasicDialogWidget
borderBLCornerStyle, borderBRCornerStyle, borderClass, borderFooterStyle, borderHeaderStyle, borderTLCornerStyle, borderTRCornerStyle, CLASS_NAME, defaults, disabledClass, inDefaultRendering, leftBorderStyle, modifyBorders, PROPERTY_BORDER_CLASS, PROPERTY_BORDERBLCORNER_STYLE, PROPERTY_BORDERBRCORNER_STYLE, PROPERTY_BORDERFOOTER_STYLE, PROPERTY_BORDERHEADER_STYLE, PROPERTY_BORDERTLCORNER_STYLE, PROPERTY_BORDERTRCORNER_STYLE, PROPERTY_DISABLED_CLASS, PROPERTY_LEFTBORDER_STYLE, PROPERTY_REMOVEBORDERCHARS, PROPERTY_REMOVEDISABLEDCHARS, PROPERTY_RIGHTBORDER_STYLE, PROPERTY_SPECIALBORDERS, removeDisabledText, rightBorderStyle, specialBorders
 
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
DialogWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
protected  void drawBorderArea(EnptuiWindowBorderComponentElement cel, StringBuffer buffer)
           
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
 void setSettings(Properties newSettings)
          Sets the Widget's settings.
 
Methods inherited from class com.ibm.hats.transform.widgets.BasicDialogWidget
createFieldWidget, designBorders, drawBorderArea, drawDisabledArea, drawDisabledArea, drawDisabledArea, drawInternalFields, drawSpecialBorderPost, drawSpecialBorderPre, getCustomProperties, getDefaultValues, getPropertyPageCount, isAllowed, isPropertyAllowed, modifyBorderText, removeBorderText, removeDisabledText, setContextAttributes
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomPropertiesBiDi, getSettings, insertAlign, insertDir, newInstance, setComponentElements, setContextAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DialogWidget

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

setSettings

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

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

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 BasicDialogWidget
Returns:
HTML output

drawBorderArea

protected void drawBorderArea(EnptuiWindowBorderComponentElement cel,
                              StringBuffer buffer)

HATS 7.5.1 (201005110649)