|
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.RenderingRule
public class RenderingRule
RenderingRule is a class representing the configuration of a global rule. It contains a reference to a PatternComponent along with its configuration settings, enablement, associated screen capture, and associated transformation fragment. RenderingRules are stored in a RenderingRuleSet, which is the format by which they are supplied to the RenderingRulesEngine upon construction.
This class does not need to be used directly by custom Component or Widget developers.
RenderingRulesEngine,
RenderingRuleSet| Field Summary | |
|---|---|
static String |
ATTR_TRANFORMATION_FRAGMENT
Transformation Fragment attribute name for a rule element. |
static String |
TAG_RULE
XML tag name for a rule element. |
| Fields inherited from interface com.ibm.hats.transform.IRenderingRule |
|---|
COPYRIGHT |
| Constructor Summary | |
|---|---|
RenderingRule(Element item)
Class contructor for a RenderingRule from a DOM Element. |
|
RenderingRule(String name,
String componentClassName,
BlockScreenRegion region,
Properties componentSettings,
String transformationFragment)
RenderingRule constructor. |
|
| Method Summary | |
|---|---|
Object |
clone()
|
String |
getAssociatedScreen()
Gets the name of the associated screen capture. |
String |
getComponentClassName()
Gets the name of the PatternComponent for this rule. |
Properties |
getComponentSettings()
Gets the settings for the PatternComponent in this rule. |
String |
getDescription()
Gets the description. |
String |
getName()
Gets the name of this rule. |
BlockScreenRegion |
getRegion()
Not currently used. |
String |
getTransformationFragment()
Gets the name of the associated transformation fragment for this rule. |
boolean |
isEnabled()
Gets whether or not this rule is enabled. |
void |
setAssociatedScreen(String string)
Sets the name of the associated screen capture. |
void |
setComponentClassName(String string)
Sets the name of the PatternComponent for this rule. |
void |
setComponentSettings(Properties properties)
Sets the settings for the PatternComponent in this rule. |
void |
setDescription(String string)
Sets the description. |
void |
setEnabled(boolean b)
Sets whether or not this rule is enabled. |
void |
setName(String string)
Sets the name of this rule. |
void |
setRegion(BlockScreenRegion region)
Not currently used. |
void |
setTransformationFragment(String string)
Sets the name of the associated transformation fragment for this rule. |
Element |
toElement(Document doc)
Serialize this rule to a DOM document. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String TAG_RULE
public static final String ATTR_TRANFORMATION_FRAGMENT
| Constructor Detail |
|---|
public RenderingRule(String name,
String componentClassName,
BlockScreenRegion region,
Properties componentSettings,
String transformationFragment)
name - componentClassName - region - not currently usedcomponentSettings - transformationFragment - public RenderingRule(Element item)
item - | Method Detail |
|---|
public Object clone()
clone in class Objectpublic String getAssociatedScreen()
getAssociatedScreen in interface IRenderingRulepublic String getDescription()
getDescription in interface IRenderingRulepublic BlockScreenRegion getRegion()
getRegion in interface IRenderingRulepublic void setAssociatedScreen(String string)
string - The name of the assoicated screen capture.public void setDescription(String string)
string - The description.public void setRegion(BlockScreenRegion region)
region - The block screen region.public boolean isEnabled()
isEnabled in interface IRenderingRulepublic void setEnabled(boolean b)
b - A boolean value indicating whether or not this rule is enabled.public String getTransformationFragment()
getTransformationFragment in interface IRenderingRulepublic void setTransformationFragment(String string)
string - The name of the associated transformation fragment for this rule.public Element toElement(Document doc)
doc - The document to append to.
public String getComponentClassName()
getComponentClassName in interface IRenderingRulepublic void setComponentClassName(String string)
string - The name of the PatternComponent for this rule.public Properties getComponentSettings()
getComponentSettings in interface IRenderingRulepublic void setComponentSettings(Properties properties)
properties - The settings for the PatternComponent in this rule.public String getName()
getName in interface IRenderingRulepublic void setName(String string)
string - The name of this rule.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||