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 EnptuiScrollbarWidget

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

public class EnptuiScrollbarWidget
extends Widget
implements HTMLRenderer, IContextDependent

EnptuiScrollbarWidget renders an ENPTUI Scrollbar. It takes EnptuiScrollbarComponentElements as inputs.

Please refer to the User's Guide for detail on this Widget's settings.

See Also:
EnptuiScrollbarComponentElement

Field Summary
static String CLASS_NAME
           
static String COLOR_BUTTONARROW_BLACK
           
static String COLOR_BUTTONARROW_WHITE
           
static Properties defaults
          Default settings for this Widget.
protected  com.ibm.hats.transform.html.HatsHTMLElementFactory htmlElementFactory
           
static String PROPERTY_BUTTONARROW_COLOR
           
 
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.IContextDependent
COPYRIGHT
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
EnptuiScrollbarWidget(ComponentElement[] componentElement, Properties settings)
          Class constructor.
 
Method Summary
 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.
 void setSettings(Properties settings)
          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, setContextAttributes
 
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

defaults

public static Properties defaults
Default settings for this Widget.


htmlElementFactory

protected com.ibm.hats.transform.html.HatsHTMLElementFactory htmlElementFactory

PROPERTY_BUTTONARROW_COLOR

public static final String PROPERTY_BUTTONARROW_COLOR
See Also:
Constant Field Values

COLOR_BUTTONARROW_WHITE

public static final String COLOR_BUTTONARROW_WHITE
See Also:
Constant Field Values

COLOR_BUTTONARROW_BLACK

public static final String COLOR_BUTTONARROW_BLACK
See Also:
Constant Field Values
Constructor Detail

EnptuiScrollbarWidget

public EnptuiScrollbarWidget(ComponentElement[] componentElement,
                             Properties settings)
Class constructor.

Parameters:
componentElement -
settings -
See Also:
Widget.Widget(ComponentElement[], Properties)
Method Detail

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

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

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

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

setSettings

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

Overrides:
setSettings in class Widget
Parameters:
settings - The Properties to set.

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)