|
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.CalendarWidget
public class CalendarWidget
CalendarWidget renders InputComponentElements as HTML inputs with a popup windows for picking a date from a calendar.
Please refer to the User's Guide for detail on this Widget's settings.
InputComponentElement| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static Properties |
defaults
Default settings for this Widget. |
static String |
FIELD_SEPARATOR
|
static String |
FIX_DATE_PATTERN
|
static String |
LAUNCHER_TYPE_BUTTON
|
static String |
LAUNCHER_TYPE_IMAGE
|
static String |
LAUNCHER_TYPE_LINK
|
static String |
LOCALE_BROWSER
|
static String |
LOCALE_SELECTED
|
static String |
LOCALE_SERVER
|
static String |
PROPERTY_DEFAULT_VALUE
|
static String |
PROPERTY_IMAGE_FILENAME
|
static String |
PROPERTY_INLINE_CALENDAR
|
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_PATTERN
|
static String |
PROPERTY_PATTERN_LOCALE_SELECTED
|
static String |
PROPERTY_PATTERN_LOCALE_SOURCE
|
static String |
PROPERTY_RANGE_END
|
static String |
PROPERTY_RANGE_START
|
static String |
PROPERTY_RESTRICT_MAX_DATE
|
static String |
PROPERTY_RESTRICT_MIN_DATE
|
static String |
PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
|
| Fields inherited from class com.ibm.hats.transform.widgets.Widget |
|---|
componentElements, contextAttributes, settings |
| Fields inherited from interface com.ibm.hats.transform.renderers.HTMLRenderer |
|---|
COPYRIGHT |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier2 |
|---|
CLASSNAME, COPYRIGHT |
| Fields inherited from interface com.ibm.hats.common.IContextDependent |
|---|
COPYRIGHT |
| Constructor Summary | |
|---|---|
CalendarWidget(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)
Deprecated. should and will be moved |
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 |
protected void |
drawTextInput(InputComponentElement ice,
String newValue,
String caption,
StringBuffer buffer)
Renders an individual InputComponentElement as an HTML input field with the specified value and caption. |
Class |
getCustomComposite()
Returns a Class object (assignable from com.ibm.hats.studio.composites.BasePropertiesComposite) if a
custom composite is to be used to represent the customizable properties for this object or null if dynamic GUI is to be used. |
String |
getCustomCompositeName()
|
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Returns a list of this object's custom properties. |
Vector |
getCustomPropertiesBiDi(int iPageNumber,
Properties properties,
ResourceBundle bundle)
|
Properties |
getDefaultValues(int iPageNumber)
Returns this object's default property values. |
int |
getPropertyPageCount()
Returns the number of property pages associated with this object. |
static String[] |
interpretPattern(String pattern)
Deprecated. should not be in this class |
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. |
static String |
meldPatterns(String[] patterns)
Deprecated. should not be in this class |
protected boolean |
renderTable()
Determines whether or not we should render these calendar controls in a table or not. |
| Methods inherited from class com.ibm.hats.transform.widgets.Widget |
|---|
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, 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 |
|---|
public static final String CLASS_NAME
public static final String PROPERTY_PATTERN
public static final String PROPERTY_PATTERN_LOCALE_SOURCE
public static final String PROPERTY_PATTERN_LOCALE_SELECTED
public static final String PROPERTY_LAUNCHER_TYPE
public static final String PROPERTY_LAUNCHER_CAPTION
public static final String PROPERTY_IMAGE_FILENAME
public static final String PROPERTY_RESTRICT_MIN_DATE
public static final String PROPERTY_RANGE_START
public static final String PROPERTY_RESTRICT_MAX_DATE
public static final String PROPERTY_RANGE_END
public static final String PROPERTY_DEFAULT_VALUE
public static final String PROPERTY_LAUNCHER_BUTTON_STYLE_CLASS
public static final String PROPERTY_LAUNCHER_LINK_STYLE_CLASS
public static final String PROPERTY_INLINE_CALENDAR
public static final String PROPERTY_USE_EXACT_CURSOR_POSITIONING_OPTION
public static final String LOCALE_BROWSER
public static final String LOCALE_SERVER
public static final String LOCALE_SELECTED
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 FIELD_SEPARATOR
public static final String FIX_DATE_PATTERN
public static Properties defaults
| Constructor Detail |
|---|
public CalendarWidget(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 Widget
public Vector getCustomPropertiesBiDi(int iPageNumber,
Properties properties,
ResourceBundle bundle)
getCustomPropertiesBiDi in class Widget
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 Class getCustomComposite()
ICustomPropertySupplierClass object (assignable from com.ibm.hats.studio.composites.BasePropertiesComposite) if a
custom composite is to be used to represent the customizable properties for this object or null if dynamic GUI is to be used.
Note: this function only applies to HATS Studio
getCustomComposite in interface ICustomPropertySuppliergetCustomComposite in class WidgetBasePropertiesComposite) or null if dynamic GUI should be usedBasePropertiesCompositepublic String getCustomCompositeName()
getCustomCompositeName in interface com.ibm.hats.common.ICustomPropertySupplier2
protected void drawTextInput(InputComponentElement ice,
String newValue,
String caption,
StringBuffer buffer)
ice - component to rendernewValue - value for the HTML inputcaption - caption for the HTML inputbuffer - output buffer
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
public static String[] interpretPattern(String pattern)
pattern - The pattern.public static String meldPatterns(String[] patterns)
patterns - An array of String patterns.public Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class WidgetiPageNumber - page for which to retrieve default properties
public boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependent
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentname - property name
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||