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

Inheritance diagram for Rule:

[legend]

Collaboration diagram for Rule:

[legend]

Public Member Functions
_.Library.Status	AddChildElement (_.CSP.AbstractAtom atom)
	Add an child atom to this element.

_.Library.String	GetAttribute (_.Library.String name, _.Library.String default)
	Get the value of the HTML attribute name for this element. More...

	GetAttributesOrdered (paramsordered)
	Return all the parameters in a ordered array.

_.Library.Boolean	HasValue (_.Library.String name)
	Indicate if HTML attribute name has a value.

	InitAttribute (_.Library.String name, _.Library.String value, _.Library.Integer order, _.Library.String quote)
	Set the HTML attribute name for this element to value.

_.Library.String	InnerText ()
	Get the children of this tag as text.

_.Library.Boolean	IsDefined (_.Library.String name)
	Indicate if HTML attribute name is defined.

_.Library.String	QuoteAttribute (_.Library.String name, _.Library.String default)
	Get the value of the HTML attribute name for this element. More...

_.Library.Status	RenderDefaultEndTag ()
	Exposes default rendering of tag without needing to use ##super. More...

_.Library.Status	RenderDefaultStartTag ()
	Exposes default rendering of tag without needing to use ##super. More...

_.Library.Status	RenderEndTag ()
	Default rendering of the end tag is a no operation. More...

_.Library.Status	RenderStartTag ()
	Default rendering of the start tag is to just continue. More...

	SetAttribute (_.Library.String name, _.Library.String value)
	Set the HTML attribute name for this element to value.

_.Library.Status	ValidateTag ()
	Validate that rule attributes are valid.

Public Member Functions inherited from AbstractAtom
	PopDefaultSection ()
	Pop default section from the top of the stack of section identifiers. More...

	PushDefaultSection (_.Library.String sectionblock)
	Add new default section to the top of the stack of section identifiers. More...

	WriteCSPServer (_.Library.String line, _.Library.Boolean keepTogether)
	Generate COS command in CSP page class that is in line. More...

	WriteCSPText (_.Library.String line, _.Library.Boolean crlf)
	Generate Write command in CSP page class to write the. More...

	WriteExpressionText (_.Library.String expr, _.Library.Boolean crlf)
	Generate Write command in CSP page class to write the. More...

	WriteServer (_.Library.String line, _.Library.Boolean keepTogether)
	Generate COS command in CSP page class that is in line.

	WriteText (_.Library.String line, _.Library.Boolean crlf)
	Generate Write command in CSP page class to write the. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.Status	OnMatch (_.CSP.Rule rule)
	Default OnMatch method for rules is to do nothing. More...

Public Attributes
	Children
	A list of any sub-items contained within this element. More...

	Closed
	A boolean value specifying whether this element is self-closed. More...

	Family
	A string specifying the rule family. More...

	HasEndTag
	A boolean value specifying whether this element has an end tag. More...

	LineNumber
	This attribute speficies the line number on which this tag starts. More...

	NewSection
	If not "", this rule will start a new section named NewSection. More...

	Rule
	A string specifying the rule name. More...

	TagAttributes
	An array of strings containing the HTML properties associated with. More...

	Text
	This attribute always returns "". More...

	TextOnly
	A integer value specifying how tags are to be handled within. More...

Public Attributes inherited from AbstractAtom
	Parent
	More...

	TagName
	More...

Private Member Functions
_.Library.Status	OnNew (_.Library.String initval)
	New method can set TagName property.

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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

Member Function Documentation

◆ GetAttribute()

_.Library.String GetAttribute	(	_.Library.String	name,
		_.Library.String	default
	)

Get the value of the HTML attribute name for this element.

The value will have ##( )## and ##' '## resolved.

Reimplemented in RuleElement.

◆ OnMatch()

_.Library.Status OnMatch ( _.CSP.Rule rule )

static

Default OnMatch method for rules is to do nothing.

OnMatch may be overridden by user rules.

Reimplemented in TagSection, and RuleRule.

◆ QuoteAttribute()

_.Library.String QuoteAttribute	(	_.Library.String	name,
		_.Library.String	default
	)

Get the value of the HTML attribute name for this element.

Return the value as a quoted string with #()#, ##( )## and ##' '## resolved.

◆ RenderDefaultEndTag()

_.Library.Status RenderDefaultEndTag ( )

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.

◆ RenderDefaultStartTag()

_.Library.Status RenderDefaultStartTag ( )

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.

◆ RenderEndTag()

_.Library.Status RenderEndTag ( )

Default rendering of the end tag is a no operation.

RenderEndTag may be overridden by user rules.

Reimplemented from AbstractAtom.

Reimplemented in TagLanguage, ScriptElement, RuleSection, RuleRule, RuleDocument, RuleAction, Element, and Document.

◆ RenderStartTag()

_.Library.Status RenderStartTag ( )

Default rendering of the start tag is to just continue.

RenderStartTag may be overridden by user rules.

Reimplemented from AbstractAtom.

Reimplemented in TagMoveToEnd, TagMethod, TagLanguage, TagCacheServer, TagCache, ScriptElement, RuleStart, RuleSection, RuleRule, RuleProperty, RuleEnd, RuleDocument, RuleDefault, RuleClass, RuleChildren, RuleCache, RuleAttribute, RuleAction, Element, and Document.

Member Data Documentation

◆ Children

Children

A list of any sub-items contained within this element.

◆ Closed

Closed

A boolean value specifying whether this element is self-closed.

◆ Family

Family

A string specifying the rule family.

◆ HasEndTag

HasEndTag

A boolean value specifying whether this element has an end tag.

◆ LineNumber

LineNumber

This attribute speficies the line number on which this tag starts.

◆ NewSection

NewSection

If not "", this rule will start a new section named NewSection.

◆ Rule

Rule

A string specifying the rule name.

◆ TagAttributes

TagAttributes

An array of strings containing the HTML properties associated with.

this tag. The array is indexed by property name and contains property values.

◆ Text

Text

This attribute always returns "".

Is it to be called by parent classes' InnerText() method.

◆ TextOnly

TextOnly

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.

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members