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 AbstractButtonWidget

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

public abstract class AbstractButtonWidget
extends Widget
implements IContextDependent


Field Summary
static String CAPTION_TYPE_BOTH
           
static String CAPTION_TYPE_DESCRIPTION
           
static String CAPTION_TYPE_LEADING_TOKEN
           
protected  String captionType
           
static String CLASS_NAME
           
static String LAYOUT_SEPARATED
           
static String LAYOUT_TABLE
           
static String PROPERTY_CAPTION_TYPE
           
static String PROPERTY_COLUMNS_PER_ROW
           
static String PROPERTY_LAYOUT
           
static String PROPERTY_SEPARATOR
           
 
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
AbstractButtonWidget(ComponentElement[] componentElements, Properties settings)
           
 
Method Summary
 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, getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, getPropertyPageCount, 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

PROPERTY_CAPTION_TYPE

public static final String PROPERTY_CAPTION_TYPE
See Also:
Constant Field Values

PROPERTY_LAYOUT

public static final String PROPERTY_LAYOUT
See Also:
Constant Field Values

PROPERTY_COLUMNS_PER_ROW

public static final String PROPERTY_COLUMNS_PER_ROW
See Also:
Constant Field Values

PROPERTY_SEPARATOR

public static final String PROPERTY_SEPARATOR
See Also:
Constant Field Values

CAPTION_TYPE_LEADING_TOKEN

public static final String CAPTION_TYPE_LEADING_TOKEN
See Also:
Constant Field Values

CAPTION_TYPE_DESCRIPTION

public static final String CAPTION_TYPE_DESCRIPTION
See Also:
Constant Field Values

CAPTION_TYPE_BOTH

public static final String CAPTION_TYPE_BOTH
See Also:
Constant Field Values

LAYOUT_TABLE

public static final String LAYOUT_TABLE
See Also:
Constant Field Values

LAYOUT_SEPARATED

public static final String LAYOUT_SEPARATED
See Also:
Constant Field Values

captionType

protected String captionType
Constructor Detail

AbstractButtonWidget

public AbstractButtonWidget(ComponentElement[] componentElements,
                            Properties settings)
Parameters:
componentElements -
settings -
Method Detail

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

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.

HATS 7.5.1 (201005110649)