|
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.PopupWidget
public class PopupWidget
PopupWidget renders input fields which have launchers to pop up a floating box for selecting valid items. It currently takes InputComponentElements as input.
InputComponentElement| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
protected int |
codepage
|
protected static String |
COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file. |
static Properties |
defaults
|
protected HTMLElementFactory |
htmlElementFactory
|
protected boolean |
isBIDI
|
static String |
LAUNCHER_TYPE_BUTTON
|
static String |
LAUNCHER_TYPE_IMAGE
|
static String |
LAUNCHER_TYPE_LINK
|
static String |
PROPERTY_CAPTION_VARIABLE
|
static String |
PROPERTY_CLOSE_CAPTION
|
static String |
PROPERTY_IMAGE_FILENAME
|
static String |
PROPERTY_LAUNCHER_BUTTON_STYLE_CLASS
|
static String |
PROPERTY_LAUNCHER_CAPTION
|
static String |
PROPERTY_LAUNCHER_LINK_STYLE_CLASS
|
static String |
PROPERTY_LAUNCHER_TYPE
|
static String |
PROPERTY_LIST_ITEMS
|
static String |
PROPERTY_SHARED_GVS
|
static String |
PROPERTY_SOURCE_HINTS
|
static String |
PROPERTY_SOURCE_STRING
|
static String |
PROPERTY_SOURCE_VARIABLE
|
static String |
PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
|
static String |
PROPERTY_VALUE_VARIABLE
|
| 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 | |
|---|---|
PopupWidget(ComponentElement[] componentElements,
Properties settings)
Class constructor. |
|
| Method Summary | |
|---|---|
static HTMLElement |
createLauncher(ContextAttributes contextAttributes,
String launcherType,
String launcherCaption,
String launcherButtonStyleClass,
String launcherLinkStyleClass,
String style,
String launcherImageName,
ScriptAction action)
Creates a popup launcher of the specified type with the specified caption or image, and the specified script action to invoke. |
static HTMLElement |
createLauncher(Hashtable contextAttributes,
String launcherType,
String launcherCaption,
String launcherButtonStyleClass,
String launcherLinkStyleClass,
String style,
String launcherImageName,
ScriptAction action)
Deprecated. |
StringBuffer |
drawHTML()
Converts ComponentElements into HTML output for embedding within a Transformation page |
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 boolean |
renderTable()
Determines whether or not to render popups in a table based on the number of component elements. |
| Methods inherited from class com.ibm.hats.transform.widgets.Widget |
|---|
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomPropertiesBiDi, 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 |
|---|
protected static final String COPYRIGHT
public static final String CLASS_NAME
public static final String PROPERTY_SOURCE_VARIABLE
public static final String PROPERTY_VALUE_VARIABLE
public static final String PROPERTY_CAPTION_VARIABLE
public static final String PROPERTY_SOURCE_STRING
public static final String PROPERTY_SOURCE_HINTS
public static final String PROPERTY_LIST_ITEMS
public static final String PROPERTY_SHARED_GVS
public static final String PROPERTY_CLOSE_CAPTION
public static final String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
protected boolean isBIDI
protected int codepage
public static Properties defaults
protected HTMLElementFactory htmlElementFactory
public static final String PROPERTY_LAUNCHER_TYPE
public static final String PROPERTY_LAUNCHER_CAPTION
public static final String PROPERTY_LAUNCHER_BUTTON_STYLE_CLASS
public static final String PROPERTY_LAUNCHER_LINK_STYLE_CLASS
public static final String LAUNCHER_TYPE_LINK
public static final String LAUNCHER_TYPE_BUTTON
public static final String LAUNCHER_TYPE_IMAGE
public static final String PROPERTY_IMAGE_FILENAME
| Constructor Detail |
|---|
public PopupWidget(ComponentElement[] componentElements,
Properties settings)
componentElements - An array of component elements.settings - The Properties settings.Widget.Widget(ComponentElement[], Properties)| Method Detail |
|---|
protected boolean renderTable()
public StringBuffer drawHTML()
HTMLRenderer
drawHTML in interface HTMLRendererpublic 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 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
HCustomProperty
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentname - property name
public boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependent
public static HTMLElement createLauncher(Hashtable contextAttributes,
String launcherType,
String launcherCaption,
String launcherButtonStyleClass,
String launcherLinkStyleClass,
String style,
String launcherImageName,
ScriptAction action)
contextAttributes - needed for generating link to imagelauncherType - CalendarWidget.LAUNCHER_TYPE_BUTTON, CalendarWidget.LAUNCHER_TYPE_LINK, or CalendarWidget.LAUNCHER_TYPE_ImagelauncherCaption - caption to use for button or linklauncherButtonStyleClass - CSS class for launcher buttonlauncherLinkStyleClass - CSS class for launcher linkstyle - style overrides for launcherlauncherImageName - image to use for launcher imageaction - javascript action to invoke upon clicking launcher
public static HTMLElement createLauncher(ContextAttributes contextAttributes,
String launcherType,
String launcherCaption,
String launcherButtonStyleClass,
String launcherLinkStyleClass,
String style,
String launcherImageName,
ScriptAction action)
contextAttributes - needed for generating link to imagelauncherType - CalendarWidget.LAUNCHER_TYPE_BUTTON, CalendarWidget.LAUNCHER_TYPE_LINK, or CalendarWidget.LAUNCHER_TYPE_ImagelauncherCaption - caption to use for button or linklauncherButtonStyleClass - CSS class for launcher buttonlauncherLinkStyleClass - CSS class for launcher linkstyle - style overrides for launcherlauncherImageName - image to use for launcher imageaction - javascript action to invoke upon clicking launcher
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||