Class RapidContext.Widget.Pane

Extends: RapidContext.Widget

The pane widget class. Used to create the simplest form of element container. It is also used inside various types of paged containers, such as a TabContainer, a Wizard or similar. A pane only uses a <div> HTML element, and supports being hidden and shown according to any page transitions required by a parent container.

Source code: RapidContext_Widget_Pane.js

Class Summary
 
Creates a new pane widget.
Field Summary
<static>  
RapidContext.Widget.Pane.ANY
The default page status.
<static>  
RapidContext.Widget.Pane.BACKWARD
The backward-only page status.
<static>  
RapidContext.Widget.Pane.FORWARD
The forward-only page status.
<static>  
RapidContext.Widget.Pane.WORKING
The working page status.
 
[read-only] The current page closeable flag value.
 
[read-only] The current page status.
 
[read-only] The current page title.
Method Summary
 
setAttrs(attrs)
Updates the widget or HTML DOM node attributes.
Methods borrowed from class RapidContext.Widget:
addAll, addChildNode, addClass, animate, blurAll, destroy, disable, enable, getChildNodes, hasClass, hide, isDisabled, isHidden, removeAll, removeChildNode, removeClass, setStyle, show, toggleClass, uid
Event Summary
 
Emitted when the pane is closed (removed) in a TabContainer.
 
Emitted when the pane is shown for viewing in a container widget.
 
Emitted when the pane is hidden from view in a container widget.
Class Detail
RapidContext.Widget.Pane(attrs)
Creates a new pane widget.
JavaScript:
var h1 = MochiKit.DOM.H1({}, "Hello, world!");
var helloPane = RapidContext.Widget.Pane({}, h1);
User Interface XML:
<Pane id="helloPane">
  <h1>Hello, world!</h1>
</Pane>
Parameters:
{Object} attrs
the widget and node attributes
{String} attrs.pageTitle Optional
the page title used when inside a page container, defaults to Page
{String/Object} attrs.pageStatus Optional
the page status used when inside a page container, use one of the predefined status constants in this class, defaults to ANY
{Boolean} attrs.pageCloseable Optional
the page closeable flag used when inside some page containers, defaults to false
{Boolean} attrs.hidden Optional
the hidden widget flag, defaults to false
{Object} ... Optional
the child widgets or DOM nodes
Returns:
{Widget} the widget DOM node
Field Detail
{String} pageTitle
[read-only] The current page title.

{Object} pageStatus
[read-only] The current page status.

{Boolean} pageCloseable
[read-only] The current page closeable flag value.

<static> RapidContext.Widget.Pane.ANY
The default page status. Allows page transitions both to the previous and the next page.

<static> RapidContext.Widget.Pane.FORWARD
The forward-only page status. Allows transitions only to the next page.

<static> RapidContext.Widget.Pane.BACKWARD
The backward-only page status. Allows transitions only to the previous page.

<static> RapidContext.Widget.Pane.WORKING
The working page status. Will disable transitions both to the previous and the next page. The page container may also display a cancel button to allow user cancellation of the ongoing operation.
Method Detail
setAttrs(attrs)
Updates the widget or HTML DOM node attributes.
Parameters:
{Object} attrs
the widget and node attributes to set
{String} attrs.pageTitle Optional
the page title used when inside a page container
{String/Object} attrs.pageStatus Optional
the page status used when inside a page container, use one of the predefined status constants in this class
{Boolean} attrs.pageCloseable Optional
the page closeable flag used when inside some page containers
{Boolean} attrs.hidden Optional
the hidden widget flag
Event Detail
onenter()
Emitted when the pane is shown for viewing in a container widget. This event signal carries no event information.

onexit()
Emitted when the pane is hidden from view in a container widget. This event signal carries no event information.

onclose()
Emitted when the pane is closed (removed) in a TabContainer. This event signal carries no event information.