Common Panel Properties and Methods

All panels defined in the view are represented by JavaScript objects that extend the Ab.view.Component class. The base class provides properties and methods that can be universally used with any panel.

Common panel properties:

Property Type Description
type String Panel type: form , console , grid , tree , view , etc.
id String Panel id as defined in AXVW.
parentEl Ext.Element Panel top-level DOM element.
restriction Ab.view.Restriction Restriction applied to the panel by another part of the view.
visible Boolean If true , the panel is currently visible.
actions Ext.util.MixedCollection Contains Ab.view.Action objects for all panel-level actions.


Common panel methods:

Method Description Parameters
clear() Clears the panel data content.
refresh(restriction)

Refreshes the panel data content from the server. If the restriction parameter is specified, the data content will be restricted.

restriction :
parsed restriction of type
Ab.view.Restriction;

addParameter( name, value) Adds a named parameter value to the panel. All added parameters will be sent to the server during the next refresh() call. The server-side workflow rules may use these parameters. name : parameter name;
value : parameter value;
show( visible, includeHeader) Shows or hides the panel.

visible : if true , the panel will be visible; if false , the panel will be hidden; (optional, default = true );

includeHeader : if true , the panel headers will also be visible or hidden; if false , the panel header visibility will not be affected; (optional, default = false );

setTitle(title) Sets the panel title text. title : localized title text;
appendTitle(title) Appends text to the original panel title defined in AXVW. title : localized title text;
addActionListener( actionId, callback, scope); Registers application function as a listener for specified panel-level action button.

actionId : action element id as defined in AXVW;

callback : reference (not name) of the function to be called;

scope : callback scope object; the function will be able to access the scope object using " this " reference; (optional, default = window object);

addEventListener( eventName, callback, scope); Registers application function as a listener for specified panel event.

eventName : one of the event types supported by this panel, for example " afterRefresh ";

callback : reference (not name) of the function to be called;

scope : callback scope object;

addDragDropListener( callback, scope);

Registers the panel area as a drag drop target, and registers specified application function as a listener for drop operation.

The callback function signature should match:

function f(dragSource, data)

where dragSource is an Ext.dd.DragSource object and the data is a custom application object provided by the drag source UI control;

callback : reference (not name) of the function to be called;

scope : callback scope object;

addDragOverListener( callback, scope);

Registers the panel area as a drag drop target, and registers specified application function as a listener for drag-over operation.

The callback function signature should match

function f(dragSource, data)

callback : reference (not name) of the function to be called;

scope : callback scope object;