RuleDocument Class Reference

The CSP.RuleDocument class represents a CSR rule. More...

Inheritance diagram for RuleDocument:

Collaboration diagram for RuleDocument:

Public Member Functions
_.Library.Status	RenderEndTag ()
	The CSP.RuleDocument class represents a CSR rule. More...
_.Library.Status	RenderStartTag ()
	Setup CSR file for compiling. More...
Public Member Functions inherited from Document
_.Library.Status	AddEventBroker ()
	Insert event broker code into the head section to load hyperevent .js files.
def	__init__ (self)
	Deprecated property for #server that is kept for compatibility. More...
Public Member Functions inherited from Rule
_.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...
	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	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...

Additional Inherited Members
Static Public Member Functions inherited from Rule
_.Library.Status	OnMatch (_.CSP.Rule rule)
	Default OnMatch method for rules is to do nothing. More...
Public Attributes inherited from Document
	NeedBroker
	NeedJS
	If true, JavaScript for HyperEvent should included in the CSP page. More...
	NeedJSBroker
Public Attributes inherited from Rule
	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...
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.RuleDocument class represents a CSR rule.

Member Function Documentation

RenderEndTag()

_.Library.Status RenderEndTag

(

)

The CSP.RuleDocument class represents a CSR rule.

Compile of CSR file complete.

Check for duplicate rules.

Reimplemented from Document.

RenderStartTag()

_.Library.Status RenderStartTag

(

)

Setup CSR file for compiling.

No CSP.PageBuilder is yet

defined, so no output will be written to any CSR class.

Reimplemented from Document.