IRISLIB database
Document Class Reference

The CSP.Document class is the server-side representation of a CSP page. More...

Inheritance diagram for Document:
Collaboration diagram for Document:

Public Member Functions

_.Library.Status AddEventBroker ()
 Insert event broker code into the head section to load hyperevent .js files.
 
_.Library.Status RenderEndTag ()
 The document tag for CSP acts to compile this document. More...
 
_.Library.Status RenderStartTag ()
 The document tag for CSP acts to compile this document to a. More...
 
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...
 

Public Attributes

 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...
 

Private Member Functions

_.Library.Status OnClose ()
 The CSP.Document class is the server-side representation of a CSP page. 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...
 
- 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.Document class is the server-side representation of a CSP page.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Deprecated property for #server that is kept for compatibility.


Now has the same effect as NeedJS property. If true, JavaScript for #server applet HyperEvent should included in the CSP page.  

Deprecated property for #call that is kept for compatibility.

Now has the same effect as NeedJS property. If true, JavaScript for #call iframe HyperEventshould included in the CSP page.  

Reimplemented from Rule.

Member Function Documentation

◆ OnClose()

_.Library.Status OnClose ( )
private

The CSP.Document class is the server-side representation of a CSP page.

Make sure that we are cleaned up.

Reimplemented from RegisteredObject.

◆ RenderEndTag()

_.Library.Status RenderEndTag ( )

The document tag for CSP acts to compile this document.

Finish building the class and cleanup.

Reimplemented from Rule.

Reimplemented in RuleRule, and RuleDocument.

◆ RenderStartTag()

_.Library.Status RenderStartTag ( )

The document tag for CSP acts to compile this document to a.

class that will render it on demand.

Reimplemented from Rule.

Reimplemented in RuleRule, and RuleDocument.

Member Data Documentation

◆ NeedBroker

NeedBroker

◆ NeedJS

NeedJS

If true, JavaScript for HyperEvent should included in the CSP page.

 

◆ NeedJSBroker

NeedJSBroker