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 BasicDialogWidget

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

public class BasicDialogWidget
extends Widget
implements HTMLRenderer, IContextDependent

BasicDialogWidget 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
protected  String borderBLCornerStyle
           
protected  String borderBRCornerStyle
           
protected  String borderClass
           
protected  String borderFooterStyle
           
protected  String borderHeaderStyle
           
protected  String borderTLCornerStyle
           
protected  String borderTRCornerStyle
           
static String CLASS_NAME
           
protected static Properties defaults
           
protected  String disabledClass
           
protected  HTMLElementFactory htmlElementFactory
           
protected  boolean inDefaultRendering
           
protected  String leftBorderStyle
           
 boolean modifyBorders
           
static String PROPERTY_BORDER_CLASS
           
static String PROPERTY_BORDERBLCORNER_STYLE
           
static String PROPERTY_BORDERBRCORNER_STYLE
           
static String PROPERTY_BORDERFOOTER_STYLE
           
static String PROPERTY_BORDERHEADER_STYLE
           
static String PROPERTY_BORDERTLCORNER_STYLE
           
static String PROPERTY_BORDERTRCORNER_STYLE
           
static String PROPERTY_DISABLED_CLASS
           
static String PROPERTY_LEFTBORDER_STYLE
           
static String PROPERTY_REMOVEBORDERCHARS
           
static String PROPERTY_REMOVEDISABLEDCHARS
           
static String PROPERTY_RIGHTBORDER_STYLE
           
static String PROPERTY_SPECIALBORDERS
           
 boolean removeDisabledText
           
protected  String rightBorderStyle
           
 boolean 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
BasicDialogWidget(ComponentElement[] componentElements, Properties settings)
          Class constructor.
 
Method Summary
protected  FieldWidget createFieldWidget(ComponentElement[] cef, Properties settings)
           
protected  void designBorders(DialogRowComponentElement[] archive, ComponentElementList cel, StringBuffer internal)
           
protected  void drawBorderArea(DialogRowComponentElement cel, StringBuffer buffer)
           
protected  void drawDisabledArea(ComponentElement[] cef, StringBuffer buffer)
           
protected  void drawDisabledArea(ComponentElementList cel, StringBuffer buffer)
           
protected  void drawDisabledArea(DisabledAreaComponentElement cel, StringBuffer buffer)
           
 StringBuffer drawHTML()
          Converts ComponentElements into HTML output for embedding within a Transformation page
protected  void drawInternalFields(ComponentElementList cel, StringBuffer buffer)
           
protected  void drawSpecialBorderPost(StringBuffer buffer)
           
protected  void drawSpecialBorderPre(int type, BlockScreenRegion consumedRegion, StringBuffer buffer)
           
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 boolean isAllowed(ContextAttributes contextAttributes)
          Gets whether or not this object should be visible in the studio given some context attributes.
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
protected  void modifyBorderText(DialogRowComponentElement cel)
           
protected  void removeBorderText(String strborder, String text, StringBuffer buffer)
           
protected  void removeDisabledText(ComponentElement[] cef)
           
 void setContextAttributes(ContextAttributes contextAttributes)
          Sets the contextAttributes of this Widget
 void setSettings(Properties newSettings)
          Sets the Widget's settings.
 
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
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values

htmlElementFactory

protected HTMLElementFactory htmlElementFactory

defaults

protected static Properties defaults

PROPERTY_BORDER_CLASS

public static final String PROPERTY_BORDER_CLASS
See Also:
Constant Field Values

PROPERTY_DISABLED_CLASS

public static final String PROPERTY_DISABLED_CLASS
See Also:
Constant Field Values

PROPERTY_LEFTBORDER_STYLE

public static final String PROPERTY_LEFTBORDER_STYLE
See Also:
Constant Field Values

PROPERTY_RIGHTBORDER_STYLE

public static final String PROPERTY_RIGHTBORDER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERFOOTER_STYLE

public static final String PROPERTY_BORDERFOOTER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERHEADER_STYLE

public static final String PROPERTY_BORDERHEADER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERTLCORNER_STYLE

public static final String PROPERTY_BORDERTLCORNER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERTRCORNER_STYLE

public static final String PROPERTY_BORDERTRCORNER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERBLCORNER_STYLE

public static final String PROPERTY_BORDERBLCORNER_STYLE
See Also:
Constant Field Values

PROPERTY_BORDERBRCORNER_STYLE

public static final String PROPERTY_BORDERBRCORNER_STYLE
See Also:
Constant Field Values

PROPERTY_SPECIALBORDERS

public static final String PROPERTY_SPECIALBORDERS
See Also:
Constant Field Values

PROPERTY_REMOVEBORDERCHARS

public static final String PROPERTY_REMOVEBORDERCHARS
See Also:
Constant Field Values

PROPERTY_REMOVEDISABLEDCHARS

public static final String PROPERTY_REMOVEDISABLEDCHARS
See Also:
Constant Field Values

leftBorderStyle

protected String leftBorderStyle

rightBorderStyle

protected String rightBorderStyle

borderHeaderStyle

protected String borderHeaderStyle

borderFooterStyle

protected String borderFooterStyle

borderTRCornerStyle

protected String borderTRCornerStyle

borderBRCornerStyle

protected String borderBRCornerStyle

borderTLCornerStyle

protected String borderTLCornerStyle

borderBLCornerStyle

protected String borderBLCornerStyle

borderClass

protected String borderClass

disabledClass

protected String disabledClass

specialBorders

public boolean specialBorders

modifyBorders

public boolean modifyBorders

removeDisabledText

public boolean removeDisabledText

inDefaultRendering

protected boolean inDefaultRendering
Constructor Detail

BasicDialogWidget

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

setContextAttributes

public void setContextAttributes(ContextAttributes contextAttributes)
Description copied from class: Widget
Sets the contextAttributes of this Widget

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

setSettings

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

Overrides:
setSettings in class Widget
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
Returns:
HTML output

designBorders

protected void designBorders(DialogRowComponentElement[] archive,
                             ComponentElementList cel,
                             StringBuffer internal)

drawSpecialBorderPre

protected void drawSpecialBorderPre(int type,
                                    BlockScreenRegion consumedRegion,
                                    StringBuffer buffer)

drawSpecialBorderPost

protected void drawSpecialBorderPost(StringBuffer buffer)

removeBorderText

protected void removeBorderText(String strborder,
                                String text,
                                StringBuffer buffer)

modifyBorderText

protected void modifyBorderText(DialogRowComponentElement cel)

removeDisabledText

protected void removeDisabledText(ComponentElement[] cef)

createFieldWidget

protected FieldWidget createFieldWidget(ComponentElement[] cef,
                                        Properties settings)

drawBorderArea

protected void drawBorderArea(DialogRowComponentElement cel,
                              StringBuffer buffer)

drawDisabledArea

protected void drawDisabledArea(DisabledAreaComponentElement cel,
                                StringBuffer buffer)

drawDisabledArea

protected void drawDisabledArea(ComponentElementList cel,
                                StringBuffer buffer)

drawDisabledArea

protected void drawDisabledArea(ComponentElement[] cef,
                                StringBuffer buffer)

drawInternalFields

protected void drawInternalFields(ComponentElementList cel,
                                  StringBuffer buffer)

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

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

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

isPropertyAllowed

public boolean isPropertyAllowed(String name,
                                 ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not the specified property should be visible in the component or widget settings. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Specified by:
isPropertyAllowed in interface IContextDependent
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

isAllowed

public boolean isAllowed(ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not this object should be visible in the studio given some context attributes. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Specified by:
isAllowed in interface IContextDependent
Returns:
whether or not this Component or Widget is allowed in the specified context

HATS 7.5.1 (201005110649)