|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.widgets.Widget
com.ibm.hats.transform.widgets.BasicDialogWidget
public class BasicDialogWidget
BasicDialogWidget renders HTML for DisabledAreaComponentElements and DialogRowComponentElements created by the DialogComponent.
| Property | Description | Type | Default Value |
|---|---|---|---|
| borderClass | CSS class to use for the border | String | |
| disabledClass | CSS class to use for the disabled area | String | HDF |
| leftBorderStyle | CSS style to use for the left border | String | |
| rightBorderStyle | CSS style to use for the right border | String | |
| borderHeaderStyle | CSS style to use for the top border | String | |
| borderFooterStyle | CSS style to use for the bottom border | String | |
| borderTLCornerStyle | CSS style to use for the border corner in the top left | String | |
| borderTRCornerStyle | CSS style to use for the border corner in the top right | String | |
| borderBLCornerStyle | CSS style to use for the border corner in the bottom left | String | |
| borderBRCornerStyle | CSS style to use for the border corner in the bottom right | String | |
| specialBorders | Whether or not to use specialized borders instead of the original text | Boolean | true |
| removeBorderCharacters | Whether or not to show the original border characters | Boolean | false |
| removeDisabledCharacters | Whether or not to show the area outside of the dialog | Boolean | true |
DialogComponent,
DialogRowComponentElement,
DisabledAreaComponentElement| 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 |
|---|
public static final String CLASS_NAME
protected HTMLElementFactory htmlElementFactory
protected static Properties defaults
public static final String PROPERTY_BORDER_CLASS
public static final String PROPERTY_DISABLED_CLASS
public static final String PROPERTY_LEFTBORDER_STYLE
public static final String PROPERTY_RIGHTBORDER_STYLE
public static final String PROPERTY_BORDERFOOTER_STYLE
public static final String PROPERTY_BORDERHEADER_STYLE
public static final String PROPERTY_BORDERTLCORNER_STYLE
public static final String PROPERTY_BORDERTRCORNER_STYLE
public static final String PROPERTY_BORDERBLCORNER_STYLE
public static final String PROPERTY_BORDERBRCORNER_STYLE
public static final String PROPERTY_SPECIALBORDERS
public static final String PROPERTY_REMOVEBORDERCHARS
public static final String PROPERTY_REMOVEDISABLEDCHARS
protected String leftBorderStyle
protected String rightBorderStyle
protected String borderHeaderStyle
protected String borderFooterStyle
protected String borderTRCornerStyle
protected String borderBRCornerStyle
protected String borderTLCornerStyle
protected String borderBLCornerStyle
protected String borderClass
protected String disabledClass
public boolean specialBorders
public boolean modifyBorders
public boolean removeDisabledText
protected boolean inDefaultRendering
| Constructor Detail |
|---|
public BasicDialogWidget(ComponentElement[] componentElements,
Properties settings)
componentElements - An array of component elements.settings - The Properties settings.Widget.Widget(ComponentElement[], Properties)| Method Detail |
|---|
public void setContextAttributes(ContextAttributes contextAttributes)
Widget
setContextAttributes in class WidgetcontextAttributes - The contextAttributes to setpublic void setSettings(Properties newSettings)
Widget
setSettings in class WidgetnewSettings - The Properties to set.public StringBuffer drawHTML()
HTMLRenderer
drawHTML in interface HTMLRenderer
protected void designBorders(DialogRowComponentElement[] archive,
ComponentElementList cel,
StringBuffer internal)
protected void drawSpecialBorderPre(int type,
BlockScreenRegion consumedRegion,
StringBuffer buffer)
protected void drawSpecialBorderPost(StringBuffer buffer)
protected void removeBorderText(String strborder,
String text,
StringBuffer buffer)
protected void modifyBorderText(DialogRowComponentElement cel)
protected void removeDisabledText(ComponentElement[] cef)
protected FieldWidget createFieldWidget(ComponentElement[] cef,
Properties settings)
protected void drawBorderArea(DialogRowComponentElement cel,
StringBuffer buffer)
protected void drawDisabledArea(DisabledAreaComponentElement cel,
StringBuffer buffer)
protected void drawDisabledArea(ComponentElementList cel,
StringBuffer buffer)
protected void drawDisabledArea(ComponentElement[] cef,
StringBuffer buffer)
protected void drawInternalFields(ComponentElementList cel,
StringBuffer buffer)
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class WidgetiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertypublic int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Widgetpublic Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class WidgetiPageNumber - page for which to retrieve default properties
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentname - property name
public boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependent
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||