Class jabberwerx.ui.JWView

The jQuery-wrapped content element for this jabberwerx.ui.JWView.

NOTE: Do not modify this value directly; instead it is created via #render and deleted via #remove.

Called by #render to generate the content for this View. Subclasses MUST override this method, returning the DOM element that is to be this view's content.

NOTE: This method should not be called directly; instead it is called by #render when necessary.

Destroys this view. This implementation calls #remove before calling the superclass' implementation.

Called by #remove to destroy the DOM content of this view. The current implementation does nothing.

Subclasses MAY override this method to perform any necessary cleanup. The value of #jq has not yet been deleted.

NOTE: This method should not be called directly; instead it is called by #remove when necessary.

Retrieves or changes the dimensions of this view. This method is a convenience for calling #width and #height within a single method call, although #update is only called once.

If this method is called without any arguments, the current dimensions are returned. Otherwise, the dimensions are changed and this jabberwerx.ui.JWView is returned.

The return value (or value of {dim}) is an object with the following properties:

{
  width: {Number|String},    //the pixel width (if Number), or CSS
                             //value (if String)
  height: {Number|String},   //the pixel height (if Number), or CSS
                             //value (if String)
}

Retrieves or changes the height of this view.

If {h} is not defined, this method returns the current height of this view, in pixels. Otherwise the height is changed to the value of {h} in pixels (if a Number) or the CSS value (if a String), #update is called (unless {noupdate} is true), and this jabberwerx.ui.JWView is returned.

If this view is not currently rendered, this method returns 0 for retrieval, and ignores {h} for changes.

Hides the view if visible in the document. View state is kept in #jq so this method does nothing if called before #render .

Retreives the parent jabberwerx.ui.JWView for this instance. This method locates the parent by recursing through the parent DOM elments until a jabberwerx.ui.JWView instance is found.

Set or retrieve built in persistence flags. The jabberwerx.ui.JWView base class can serialize its JQ reference by storing the JQ's innerHTML. The default is #persist_none. If #persist_html is set the base class will store and reload the JQ's html. /p>

Removes this jabberwerx.ui.JWView's contents. This method performs the following:

1. Calls #destroyDOM.
2. Removes #jq from its parent
3. Deletes #jq.
4. Triggers the "viewRemoved" event with the previous value of #jq as the data.

If #jq is not valid when this method is called, no actions are taken.

Renders this jabberwerx.ui.JWView. This method performs the following:

1. Calls #createDOM to generate the content to render
2. Stores the content as a jQuery-wrapped object in #jq.
3. Triggers the "viewRendered" event with the jQuery-wrapped object as data.
4. Calls #update.
5. Returns #jq.

If this view has already been rendered, then #update is called and #jq is returned.

Called by #restoreRender to generate the content for this View from previously persisted state data. Subclasses may override this method, returning the DOM element that is to be this view's content. Default behavior is to return the result of a #createDOM call if #persist_html was not in #persistOptions. If HTML was persisted this base class returns the DOM element built from it. .

NOTE: This method should not be called directly; instead it is called by #restoreRender when necessary.

Renders this jabberwerx.ui.JWView the first time after rehydration.

This method is called the first time the view is rendered after rehydration. Unlike #render this method invokes restoreDOM, restoreUpdate and does not trigger any events.

Called by #restoreRender when the view's jq member has been assigned. Gives subclasses a way of initializing the DOM, above and beyond #update. Update is used to refresh the view from its current state (redraw) *or* from associated models, a behavior undeeded and unwanted when rehydrating.

NOTE: This method should not be called directly; instead it is called by #restoreRender when necessary.

Determines if this view should be saved in object graphs. Default behavior is to include the view

Shows the view if hidden in the document. View state is kept in #jq so this method does nothing if called before #render .

Updates this view. This method is called by #dimensions, #height, and #width automatically, but may also be called directly to force an update of the view.

Subclasses SHOULD override this method to perform any necessary changes, but SHOULD call the super-classes implementation.

Called when this instance has been rehydrated. Subclass changes #render to a #restoreRender reference. This allows special handling of the first render after a rehydration.

Retrieves or changes the width of this view.

If {w} is not defined, this method returns the current width of this view, in pixels. Otherwise the width is changed to the value of {w} in pixels (if a Number) or the CSS value (if a String), #update is called (unless {noupdate} is true), and this jabberwerx.ui.JWView is returned.

If this view is not currently rendered, this method returns 0 for retrieval, and ignores {w} for changes.

Check #persistOptions and save the current JQ's xml as needed. Sets JQ to null to prevent any further serialization of that object.