Docs For Class jResponseXul

Description

Generate a XUL window

see: jResponse

Located in /core/response/jResponseXul.class.php (line 24)

jResponse
   |
   --jResponseXul

Direct descendents

Class	Description
jResponseXulOverlay	Generate a XUL overlay
jResponseXulPage	Generate a XUL page (to display inside a xul iframe...)
jResponseXulDialog	Generate a XUL dialog

Variable Summary

jTpl $body

string $bodyTpl

boolean $fetchOverlays

array $rootAttributes

string $title

mixed $_bodyBottom

mixed $_bodyTop

array $_CSSLink

mixed $_headSent

array $_JSCode

array $_JSLink

array $_overlays

mixed $_root

string $_type

Method Summary

jResponseXul __construct ()

void addContent (string $content, [boolean $beforeTpl = false])

void addCSSLink (string $src, [ $params = array ()])

void addJSCode (string $code)

void addJSLink (string $src, [ $params = array()])

void addOverlay (string $src)

void clearHeader ( $what)

void doAfterActions ()

string getFormatedErrorMsg ()

void getFormatType ()

boolean output ()

void outputErrors ()

void outputHeader ()

void _commonProcess ()

void _otherthings ()

Variables

jTpl $body = null (line 73)

template engine to generate the window content

access: public

string $bodyTpl = '' (line 79)

selector of the template to use

access: public

boolean $fetchOverlays = false (line 85)

says if an event is sent to retrieve overlays url for the xul content

access: public

array $rootAttributes = array() (line 61)

list of attributes and their values for the root element

access: public

string $title = '' (line 67)

Title of the window

access: public

mixed $_bodyBottom = array() (line 88)

access: protected

mixed $_bodyTop = array() (line 87)

access: protected

array $_CSSLink = array () (line 39)

header content : list of css file links

access: protected

mixed $_headSent = false (line 89)

access: protected

array $_JSCode = array () (line 49)

header content : list of piece of javascript code

access: protected

array $_JSLink = array () (line 44)

header content : list of javascript file links

access: protected

array $_overlays = array () (line 34)

header content : list of overlay links

access: protected

mixed $_root = 'window' (line 55)

root tag name.

could be override into child class for other xul document

access: protected

Redefined in descendants as:

string $_type = 'xul' (line 28)

access: protected

Redefinition of:

jResponse::$_type: ident of the response type

Redefined in descendants as:

Inherited Variables

Inherited from jResponse

jResponse::$_acceptSeveralErrors
jResponse::$_errorMessages
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg

Methods

Constructor __construct (line 94)

constructor

jResponseXul __construct ()

Redefinition of:

jResponse::__construct(): constructor

addContent (line 201)

call it to add manually content before or after the main content

void addContent (string $content, [boolean $beforeTpl = false])

string $content: xul content
boolean $beforeTpl: true if you want to add before, false for after

addCSSLink (line 229)

add a link to a css stylesheet

void addCSSLink (string $src, [ $params = array ()])

string $src: url
$params

addJSCode (line 239)

add a piece of javascript code

void addJSCode (string $code)

string $code: javascript source code

addJSLink (line 220)

add a link to a javascript file

void addJSLink (string $src, [ $params = array()])

string $src: url
$params

addOverlay (line 213)

add a link to a xul overlay for the xul page

void addOverlay (string $src)

string $src: url of a xul overlay

clearHeader (line 334)

clear all header informations

var: list of keyword
access: public

void clearHeader ( $what)

$what

doAfterActions (line 285)

The method you can overload in your inherited XUL response

overload it if you want to add processes (stylesheet, head settings, additionnal content etc..) after all actions

since: 1.1
access: protected

void doAfterActions ()

getFormatedErrorMsg (line 188)

return: formated errors
access: protected

string getFormatedErrorMsg ()

getFormatType (line 344)

access: public

void getFormatType ()

Redefinition of:

jResponse::getFormatType(): return the format type name (eg the family type name)

output (line 103)

generate the xul content.

return: true if it's ok
access: public

boolean output ()

Redefinition of:

jResponse::output(): Send the response in the correct format.

outputErrors (line 168)

access: public

void outputErrors ()

Redefinition of:

jResponse::outputErrors(): Send a response with only error messages which appears during the action

outputHeader (line 243)

access: protected

void outputHeader ()

_commonProcess (line 294)

same use as doAfterActions, but deprecated method. It is just here for compatibility with Jelix 1.0.

Use doAfterActions instead

deprecated:
access: protected

void _commonProcess ()

_otherthings (line 300)

access: protected

void _otherthings ()

Redefined in descendants as:

jResponseXulOverlay::_otherthings()

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::acceptSeveralErrors()
jResponse::addHttpHeader()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::hasErrors()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setHttpStatus()