Class Zapatec.Pane

Object
   |
   +--Zapatec.Pane

class Zapatec.Pane

Defined in pane.js

Field Detail

loadDataHtml

Object loadDataHtml

Loads data from the HTML|Xml fragment source. \param strSource [string] source HTML fragment.

id

<static> Object id

Zapatec.Pane

Zapatec.Pane(objArgs)

Zapatec Pane object. Creates the element for displaying content and gives an interface to work with it.

Parameters:
config - [object] - pane config. Constructor recognizes the following properties of the config object \code property name | description ------------------------------------------------------------------------------------------------- parent | [string or object] Reference to DOM element where | newly created Pane will be placed. By default - | document.body containerType | [string] Required. Possible values: div|iframe|current - | what type of pane to create | * div - create new DIV element and add it into parent | * iframe - create new IFRAME element and add it into parent | * current - use parent as pane container sourceType | [string] see Zapatec.Widget documentation for this option source | [string or object] see Zapatec.Widget documentation | for this option width | [number] width of the Pane in "px" height | [number] height of the Pane in "px" autoContentWidth | [boolean] Option which determines if the width of the Pane will be | determined automatically. autoContentHeight | [boolean] Option which determines if the height of the Pane will be | determined automatically. id | [string] Optionally you can pass some string to be able to seek Pane by this ID onlyInit | [boolean] For developing needs this option will disable calling create method | of the Pane from init, so HTML structure will not be created after calling | constructor. showLoadingIndicator | [boolean] Determines if a loading progress indicator is to be shown | inside pane during loading. Default is true. overflow | [string] Determines pane content overflow style. Default to "auto". \endcode

create

Object create(width, height)

Creates the HTML part of the Pane by calling prepareHtml, if it was not called before and adds the container to the document tree.

Parameters:
width - [number] - optional, width that can be different from the config's one
height - [number] - optional, height that can be different from the config's one

destroy

void destroy()

Destroys current pane instance removing all related HTML elements.

fireWhenReady

void fireWhenReady(func)

getContainer

Object getContainer()

getContentElement

Object getContentElement()

getHeight

Object getHeight()

getIframeDocument

Object getIframeDocument()

getWidth

Object getWidth()

hide

void hide()

Hides the Pane container.

hideIndicator

void hideIndicator()

Hides the indicater.

init

void init(objArgs)

Init function. Actually this function does the creation of element itself, not the constructor.

initPane

Object initPane()

isReady

Object isReady()

loadDataHtmlText

void loadDataHtmlText(content)

loadDataJson

Object loadDataJson(objSource)

Loads data from the HTML source. \param objSource [object] source HTMLElement object.

prepareHtml

void prepareHtml()

Creates all needed HTML elements, if we are not reusing parent.

removeBorder

Object removeBorder()

setContent

Object setContent(content)

Sets the content of the pane.

Parameters:
content - [string or object] - string content or reference to DOM element

Returns:
[boolean] - true if successfull, otherwise false.

setHeight

void setHeight(height)

setPaneContent

Object setPaneContent(content, type)

setWidth

void setWidth(width)

show

void show()

Shows the Pane container.

showIndicator

void showIndicator(message)

Shows the indicater.

Parameters:
message - {string} message to show.