Skip to main content
Pentaho Documentation

Context

Context

The Context class is an implementation of the IContext interface.

Implements

Constructor

Name Description
new Context(spec, defaultSpec)
 
Static

Creates a context given its specification.

Members

Name Description
application : nonEmptyString

Gets the identifier of the client application.

locale : nonEmptyString

Gets the identifier of the locale.

reservedChars : nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

server : pentaho.context.IServer

Gets information about the server web application.

theme : nonEmptyString

Gets the identifier of the theme.

user : pentaho.context.IUser

Gets information about the user.

Methods

Name Description
createChild(childSpec) : pentaho.context.IContext

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

toSpec() : pentaho.context.spec.IContext

Creates a specification with the information of this context.

Constructor Details

new Context(spec, defaultSpec)
 
Static

Creates a context given its specification.

Any absent or undefined-valued properties assume the values of the given default specification, if any, or null, if none.

Source: javascript/web/pentaho/context/impl/Context.js, line 41

Parameters:
Name Default Value Summary
spec : pentaho.context.spec.IContext
 
Optional

The context specification.

defaultSpec : pentaho.context.spec.IContext
 
Optional

The context specification from which unspecified or undefined spec properties are initialized.

Members Details

Implements:
application: nonEmptyString

Gets the identifier of the client application.

Source: doc-js/pentaho/context/IContext.jsdoc, line 34

Implements:
locale: nonEmptyString

Gets the identifier of the locale.

Source: doc-js/pentaho/context/IContext.jsdoc, line 70

Implements:
reservedChars: nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

Source: doc-js/pentaho/context/IContext.jsdoc, line 79

Implements:
server: pentaho.context.IServer

Gets information about the server web application.

Source: doc-js/pentaho/context/IContext.jsdoc, line 52

Implements:
theme: nonEmptyString

Gets the identifier of the theme.

Source: doc-js/pentaho/context/IContext.jsdoc, line 61

Implements:
user: pentaho.context.IUser

Gets information about the user.

Source: doc-js/pentaho/context/IContext.jsdoc, line 43

Methods Details

Implements:
createChild(childSpec) : pentaho.context.IContext

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

Source: doc-js/pentaho/context/IContext.jsdoc, line 88

Parameters:
Name Default Value Summary
childSpec : pentaho.context.spec.IContext
 
Optional

The child context specification.

Returns:
Name Description
pentaho.context.IContext

The child context.

Implements:
toSpec() : pentaho.context.spec.IContext

Creates a specification with the information of this context.

Source: doc-js/pentaho/context/IContext.jsdoc, line 99

Returns:
Name Description
pentaho.context.spec.IContext

The context specification.

See also:  pentaho.context.IContext#toJSON