Home > Class Reference > ENSLIB namespace > %CSP.Rule

%CSP.Rule

class %CSP.Rule extends %CSP.AbstractAtom

The %CSP.Rule class is the super class of all rule generated classes that represent elements within the DOM model.

Property Inventory

Method Inventory

Properties

property Children as list of %CSP.AbstractAtom;
A list of any sub-items contained within this element.
Property methods: ChildrenBuildValueArray(), ChildrenCollectionToDisplay(), ChildrenCollectionToOdbc(), ChildrenDisplayToCollection(), ChildrenGet(), ChildrenGetObject(), ChildrenGetObjectId(), ChildrenGetSwizzled(), ChildrenIsValid(), ChildrenOdbcToCollection(), ChildrenSet(), ChildrenSetObject(), ChildrenSetObjectId()
property Closed as %Boolean [ InitialExpression = 0 ];
A boolean value specifying whether this element is self-closed.
Property methods: ClosedDisplayToLogical(), ClosedGet(), ClosedIsValid(), ClosedLogicalToDisplay(), ClosedNormalize(), ClosedSet()
property Family as %String;
A string specifying the rule family.
Property methods: FamilyDisplayToLogical(), FamilyGet(), FamilyIsValid(), FamilyLogicalToDisplay(), FamilyLogicalToOdbc(), FamilyNormalize(), FamilySet()
property HasEndTag as %Boolean [ InitialExpression = 0 ];
A boolean value specifying whether this element has an end tag.
Property methods: HasEndTagDisplayToLogical(), HasEndTagGet(), HasEndTagIsValid(), HasEndTagLogicalToDisplay(), HasEndTagNormalize(), HasEndTagSet()
property LineNumber as %Integer;
This attribute speficies the line number on which this tag starts.
Property methods: LineNumberDisplayToLogical(), LineNumberGet(), LineNumberIsValid(), LineNumberLogicalToDisplay(), LineNumberNormalize(), LineNumberSet()
property NewSection as %String;
If not "", this rule will start a new section named NewSection.
Property methods: NewSectionDisplayToLogical(), NewSectionGet(), NewSectionIsValid(), NewSectionLogicalToDisplay(), NewSectionLogicalToOdbc(), NewSectionNormalize(), NewSectionSet()
property Rule as %String;
A string specifying the rule name.
Property methods: RuleDisplayToLogical(), RuleGet(), RuleIsValid(), RuleLogicalToDisplay(), RuleLogicalToOdbc(), RuleNormalize(), RuleSet()
property TagAttributes as array of %String;
An array of strings containing the HTML properties associated with this tag. The array is indexed by property name and contains property values.
Property methods: TagAttributesBuildValueArray(), TagAttributesCollectionToDisplay(), TagAttributesCollectionToOdbc(), TagAttributesDisplayToCollection(), TagAttributesDisplayToLogical(), TagAttributesGet(), TagAttributesGetObject(), TagAttributesGetObjectId(), TagAttributesGetSwizzled(), TagAttributesIsValid(), TagAttributesLogicalToDisplay(), TagAttributesLogicalToOdbc(), TagAttributesNormalize(), TagAttributesOdbcToCollection(), TagAttributesSet(), TagAttributesSetObject(), TagAttributesSetObjectId()
property Text as %String;
This attribute always returns "". Is it to be called by parent classes' InnerText() method.
Property methods: TextDisplayToLogical(), TextGet(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextOnlyDisplayToLogical(), TextOnlyGet(), TextOnlyIsValid(), TextOnlyLogicalToDisplay(), TextOnlyNormalize(), TextOnlySet(), TextSet()
property TextOnly as %Integer [ InitialExpression = 0 ];
A integer value specifying how tags are to be handled within the body content of this tag: TextOnly=0 Normal parsing of tags TextOnly=1 Tags are ignored in the body content and always treated as text. TextOnly=2 Tags are processed only if a matching rule is found. Otherwise the tag is treated as text.
Property methods: TextOnlyDisplayToLogical(), TextOnlyGet(), TextOnlyIsValid(), TextOnlyLogicalToDisplay(), TextOnlyNormalize(), TextOnlySet()

Methods

method %OnNew(initval As %String = "") as %Status [ Language = objectscript ]
New method can set TagName property.
method AddChildElement(atom As %CSP.AbstractAtom) as %Status [ Language = objectscript ]
Add an child atom to this element.
method GetAttribute(name As %String, default As %String = "") as %String [ Language = objectscript ]
Get the value of the HTML attribute name for this element. The value will have ##( )## and ##' '## resolved.
method GetAttributesOrdered(ByRef paramsordered) [ Language = objectscript ]
Return all the parameters in a ordered array.
method HasValue(name As %String) as %Boolean [ Language = objectscript ]
Indicate if HTML attribute name has a value.
method InitAttribute(name As %String, value As %String, order As %Integer = 0, quote As %String = "") [ Language = objectscript ]
Set the HTML attribute name for this element to value.
method InnerText() as %String [ Language = objectscript ]
Get the children of this tag as text
method IsDefined(name As %String) as %Boolean [ Language = objectscript ]
Indicate if HTML attribute name is defined.
classmethod OnMatch(rule As %CSP.Rule) as %Status [ Language = objectscript ]
Default OnMatch method for rules is to do nothing. OnMatch may be overridden by user rules.
method QuoteAttribute(name As %String, default As %String = "") as %String [ Language = objectscript ]
Get the value of the HTML attribute name for this element. Return the value as a quoted string with #()#, ##( )## and ##' '## resolved.
method RenderDefaultEndTag() as %Status [ Language = objectscript ]
Exposes default rendering of tag without needing to use ##super. Writes code into the routine builder object that will do the default rendering for an end tag.
method RenderDefaultStartTag() as %Status [ Language = objectscript ]
Exposes default rendering of tag without needing to use ##super. Writes code into the routine builder object that will do the default rendering for a begin tag.
method RenderEndTag() as %Status [ Language = objectscript ]
Default rendering of the end tag is a no operation RenderEndTag may be overridden by user rules.
method RenderStartTag() as %Status [ Language = objectscript ]
Default rendering of the start tag is to just continue RenderStartTag may be overridden by user rules.
method SetAttribute(name As %String, value As %String) [ Language = objectscript ]
Set the HTML attribute name for this element to value.
method ValidateTag() as %Status [ Language = objectscript ]
Validate that rule attributes are valid.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

Feedback