|
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.DefaultRenderingEngine
public class DefaultRenderingEngine
the default rendering engine is responsible for coordinating the rendering set through the regionmanager using the settings and providing a default rendering of the host screen.
| Field Summary | |
|---|---|
boolean |
applyGlobalRules
whether or not the global rules are being applied |
Properties |
BIDIWidgetSettings
|
static String |
CLASS_NAME
the name and package of the class |
Hashtable |
classSettings
the settings for the default rendering engine class |
ContextAttributes |
contextAttributes
the attributes for the context in which the rendering is being used |
static String |
DEFAULT_RENDERING_SET_NAME
property reference for the default rendering set name in the settings |
HsrScreen |
hostScreen
the host screen being used |
static String |
PROPERTY_APPLY_COMPONENT_WIDGETS
property reference for the components and widget settings |
static String |
PROPERTY_APPLY_GLOBAL_RULES
property reference for the global rules the settings |
static String |
PROPERTY_RENDERING_SET
property reference for the rendering set in the settings |
ScreenRegion |
region
the screen region of the host screen being used |
RenderingSet |
renderingSet
the rendering set being used |
static String |
TAG_DEFAULT_RENDERING
tag reference for the default rendering |
TextReplacementList |
textReplacement
the list of text replacements being applied to the rendering |
| Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier |
|---|
CLASSNAME |
| Constructor Summary | |
|---|---|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings)
Constructor for DefaultRenderingEngine. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
Properties BIDIWidgetSettings)
Constructor for DefaultRenderingEngine. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr)
Constructor for DefaultRenderingEngine. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr,
Properties BIDIWidgetSettings)
Constructor for DefaultRenderingEngine. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings)
Deprecated. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
Properties BIDIWidgetSettings)
Deprecated. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr)
Deprecated. |
|
DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr,
Properties BIDIWidgetSettings)
Deprecated. |
|
| Method Summary | |
|---|---|
Class |
getCustomComposite()
Retrieves the class of a composite to use. |
Vector |
getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
Creates a collection of HCustomProperty objects to describe the properties of the default rendering for a given page. |
Properties |
getDefaultValues(int iPageNumber)
Gives the properties of the default rendering for a given page. |
int |
getPropertyPageCount()
Retrieve the property page count. |
boolean |
makeRenderingItemRegionFit(RenderingItem item)
Makes the rendering item's region settings fit within the region of the host screen and the rendering engine. |
String |
renderHTML()
Uses the settings to render the rendering set and host screen into the table and transform the results to HTML strings for output to a string. |
String |
renderHTML(boolean includeSpacerRow)
Uses the settings to render the rendering set and host screen into the table and transform the results to HTML strings for output to a string. |
void |
renderHTML(Writer out)
Uses the settings to render the rendering set and host screen into the table and transform the results to HTML strings for output to the writer. |
void |
renderHTML(Writer out,
boolean includeSpacerRow)
Uses the settings to render the rendering set and host screen into the table and transform the results to HTML strings for output to the writer. |
com.ibm.hats.transform.TableObject |
renderSetToTable(RenderingSet renderingset,
com.ibm.hats.transform.TableObject table)
Renders the rendering set into the table. |
String |
showHostFields()
|
| 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_RENDERING_SET
public static final String PROPERTY_APPLY_GLOBAL_RULES
public static final String PROPERTY_APPLY_COMPONENT_WIDGETS
public static final String DEFAULT_RENDERING_SET_NAME
public static final String TAG_DEFAULT_RENDERING
public RenderingSet renderingSet
public HsrScreen hostScreen
public ScreenRegion region
public boolean applyGlobalRules
public ContextAttributes contextAttributes
public TextReplacementList textReplacement
public Hashtable classSettings
public Properties BIDIWidgetSettings
| Constructor Detail |
|---|
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
Properties BIDIWidgetSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.BIDIWidgetSettings - The Bidirectional Widget Settings for the render.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
Properties BIDIWidgetSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.BIDIWidgetSettings - The Bidirectional Widget Settings for the render.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.regionMgr - A custom region manager object for controlling component consumption.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.regionMgr - A custom region manager object for controlling component consumption.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
ContextAttributes contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr,
Properties BIDIWidgetSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.regionMgr - A custom region manager object for controlling component consumption.BIDIWidgetSettings - The Bidirectional Widget Settings for the render.
public DefaultRenderingEngine(RenderingSet renderingSet,
HsrScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable contextAttributes,
Hashtable classSettings,
com.ibm.hats.transform.regions.RegionManager regionMgr,
Properties BIDIWidgetSettings)
renderingSet - The renderingset to use.hostScreen - The host screen representation to use.region - The region that will be rendered from the host screen.applyGlobalRules - Whether or not to apply global rules to this rendering.contextAttributes - The context in which the rendering is being used.classSettings - The settings for the DefaultRenderingEngine class for the render.regionMgr - A custom region manager object for controlling component consumption.BIDIWidgetSettings - The Bidirectional Widget Settings for the render.| Method Detail |
|---|
public boolean makeRenderingItemRegionFit(RenderingItem item)
item - The rendering item.
public com.ibm.hats.transform.TableObject renderSetToTable(RenderingSet renderingset,
com.ibm.hats.transform.TableObject table)
renderingset - The rendering set to render.table - The table object to render the rendering set into.
public String showHostFields()
public void renderHTML(Writer out)
throws IOException
out - The writer to write the html strings to.
IOException
public void renderHTML(Writer out,
boolean includeSpacerRow)
throws IOException
out - The writer to write the html strings to.
IOExceptionpublic String renderHTML()
IOExceptionpublic String renderHTML(boolean includeSpacerRow)
includeSpacerRow - Specifies whether a spacer row (filled with cells) is created.
IOExceptionpublic int getPropertyPageCount()
getPropertyPageCount in interface ICustomPropertySupplierICustomPropertySupplier
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
getCustomProperties in interface ICustomPropertySupplieriPageNumber - The page number requested.properties - The current properties.bundle - The resource bundle to use.
ICustomPropertySupplierpublic Properties getDefaultValues(int iPageNumber)
getDefaultValues in interface ICustomPropertySupplieriPageNumber - The page number requested.
ICustomPropertySupplierpublic Class getCustomComposite()
getCustomComposite in interface ICustomPropertySupplierICustomPropertySupplier
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||