Basic structure of the Context Object

The Context object is made of a specific list of properties, and a number of publicly available methods.

{
    application: {
        getId: function()
    },
    area: {
        getType: function(),
        getName: function(),
        getContext: function()
    },
    component: {
        getType: function()
    },
    activeObject: {
        // Methods of the single object.
    },
    activeObjects: [{activeObject}] // An array of activeObject
    selection: [ ] // Array of objects. See below.
}

Table 1. Parameters list
Parameter	Value type	Description	Values
application.getId()	String	Returns the application Id.	"swing", …
area.getType()	String	Returns the area type.	"main" (for the main views), "editor"
area.getName()	String	Returns the area name.	"explorer", "dashboard", "myarea", "liveblogmanagement" (for "main" areas). "story" (for editors).
area.getContext()	String	Returns the area context.	"story-editor", "report-editor", "dwp-editor", "topic@editor", "topic@search", "topic@binder", "topicplan@editor", "topicplan@search", "topicplan@binder", "topicitem", "upload", "diagram-workflow", "search", "planning-calendar"
component.getType()	String	Returns the component type.	"toolbar", "grid", "objectpanel"…
activeObject	Object	Returns an object with a set of methods. Refer to : Methods of the single object for the list of methods.
activeObjects	Array	Returns an array of activeObject(s). In bulk selection mode all selected items are returned here as array. In single selection mode array length is 1. Each activeObject is coupled with one selected item. Methods of the single object operate to that item.
selection	Array of Object	Returns an array with the currently selected items. Each item has the same set of methods available. Refer to : Methods of the single object for the list of methods.

Each context has a different value for these properties.

Methods available in the Context Object

Further details on the methods available in the Context Object can be found in the Context Object Methods reference.