Class DHTMLSuite.paneSplitter

Object
   |
   +--DHTMLSuite.paneSplitter

class DHTMLSuite.paneSplitter

Purpose of class: Creates a pane splitter. (Demo)
Defined in dhtml-suite-for-applications.js

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

Field Detail

collapseExpandButtons

Object collapseExpandButtons

dataModel

Object dataModel

horizontalSplitterBorderSize

Object horizontalSplitterBorderSize

horizontalSplitterSize

Object horizontalSplitterSize

layoutCSS

Object layoutCSS

objectIndex

Object objectIndex

paneBorderLeftPlusRight

Object paneBorderLeftPlusRight

panes

Object panes

panesAssociative

Object panesAssociative

paneSizeCollapsed

Object paneSizeCollapsed

paneSplitterHandleOnResize

Object paneSplitterHandleOnResize

paneSplitterHandles

Object paneSplitterHandles

paneZIndexCounter

Object paneZIndexCounter

resizeCounter

Object resizeCounter

resizeInProgress

Object resizeInProgress

slideSpeed

Object slideSpeed

verticalSplitterSize

Object verticalSplitterSize

waitMessage

Object waitMessage

DHTMLSuite.paneSplitter

DHTMLSuite.paneSplitter()

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

addContent

Object addContent(panePosition,contentModel,onCompleteJsCode)

Add content to a pane

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)
Object - contentModel - Object of type DHTMLSuite.paneSplitterContentModel
String - onCompleteJsCode - Js code to execute when content is successfully loaded.

Returns:
Boolean Success - true if content were added successfully, false otherwise - false means that the pane don't exists or that content with this id allready has been added.

addModel

void addModel(newModel)

Add datasource for the pane splitter

Parameters:
Object - newModel - Data source, object of class DHTMLSuite.paneSplitterModel

closeAllClosableTabs

Object closeAllClosableTabs(panePosition)

Close all closable tabs, i.e. tabs where the closable attribute is set to true.

Parameters:
String - panePosition

collapsePane

void collapsePane(panePosition)

Use this method when you manually want to collapse a pane

Parameters:
String - panePosition - Position of pane, west,east,north,south

deleteContentById

void deleteContentById(id)

Delete content from a pane by index

Parameters:
String - id - Id of content to delete.

deleteContentByIndex

void deleteContentByIndex(panePosition,contentIndex)

Delete content from a pane by index

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)
Integer - contentIndex

expandPane

void expandPane(panePosition)

Use this method when you manually want to expand a pane

Parameters:
String - panePosition - Position of pane, west,east,north,south

getHtmlElIdOfCurrentlyDisplayedContent

Object getHtmlElIdOfCurrentlyDisplayedContent(panePosition)

Returns html element id of the content currently being displayed - active tab.

Parameters:
String - position - which pane. ("west","east","center","north","south")

Returns:
String id of currently displayed content(the HTML element) (active tab).

getIdOfCurrentlyDisplayedContent

Object getIdOfCurrentlyDisplayedContent(panePosition)

Returns id of the content currently being displayed - active tab.

Parameters:
String - position - which pane. ("west","east","center","north","south")

Returns:
String id of currently displayed content (active tab).

getReferenceToMainDivElOfPane

Object getReferenceToMainDivElOfPane(panePosition)

Get reference to main div element of a pane. This can for example be useful if you're using the imageSelection class and want To restrict the area for a selection. Maybe you only want your users to start selection within the center pane, not the other panes.

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)

getSizeOfPaneInPixels

Object getSizeOfPaneInPixels(panePosition)

Returns id of the content currently being displayed - active tab.

Parameters:
String - position - which pane. ("west","east","center","north","south")

Returns:
Array - Assocative array representing width and height of the pane(keys in DHTMLSuite.paneSplitter.prototype.array = "width";and "height").

getState

Object getState(panePosition)

Get state of pane

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)

Returns:
String state of pane - "collapsed" or "expanded".

hidePane

Object hidePane(panePosition)

Hide a pane

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)

init

void init()

Initializes the script

isUrlLoadedInPane

Object isUrlLoadedInPane(id,url)

This method returns true if content with a specific url exists inside a specific content container.

Parameters:
String - id - id of content object
String - url - Url of file (Url to check on)

loadContent

void loadContent(id,url,refreshAfterSeconds,onCompleteJsCode)

This method loads content from server and inserts it into the pane with the given id If you want the content to be displayed directly, remember to call the showContent method too.

Parameters:
String - id - id of content object where the element should be inserted
String - url - Url of file (the content of this file will be inserted into the define pane)
Integer - refreshAfterSeconds - Reload url after number of seconds. 0 = no refresh ( also default)
String - onCompleteJsCode - Js code to evaluate when content has been successfully loaded(Callback) - DHTMLSuite.paneSplitter.prototype.example = "myFunction()";. This string will be avaluated.

reloadContent

void reloadContent(id)

Reloads ajax content

Parameters:
String - id - id of content object to reload.

setAjaxWaitMessage

void setAjaxWaitMessage(newWaitMessage)

Specify ajax wait message - message displayed in the pane when content is being loaded from the server.

Parameters:
String - newWaitMessage = Wait message - plain text or HTML.

setContentTabTitle

void setContentTabTitle(idOfContentObject,newTitle)

New title of tab - i.e. the text inside the clickable tab.

Parameters:
String - idOfContentObject - id of content object
String - newTitle - New title of tab

setContentTitle

void setContentTitle(idOfContentObject,newTitle)

New title of content - i.e. the heading

Parameters:
String - idOfContentObject - id of content object
String - newTitle - New title of tab

setLayoutCss

void setLayoutCss(layoutCSS)

Specify name/path to a css file(default is 'pane-splitter.css')

Parameters:
String - layoutCSS = Name(or relative path) of new css path

setRefreshAfterSeconds

void setRefreshAfterSeconds(idOfContentObject,refreshAfterSeconds)

Specify a new value for when content should be reloaded.

Parameters:
String - idOfContentObject - id of content to add the value to
Integer - refreshAfterSeconds - Refresh rate of content (0 = no refresh)

setSizeOfPane

void setSizeOfPane(panePosition,newSize)

Set new size of pane

Parameters:
String - panePosition = Position of pane(east,west,south or north)
Integer - newSize = New size of pane in pixels.

setSlideSpeed

void setSlideSpeed(slideSpeed)

Set speed of slide animation.

Parameters:
Integer - slideSpeed = new slide speed ( higher = faster ) - default = 10

showContent

void showContent(id)

Makes content with a specific id visible

Parameters:
String - id - id of content to make visible(remember to have unique id's on each of your content objects)

showPane

Object showPane(panePosition)

Show a previously hidden pane

Parameters:
String - panePosition - Position of pane(west,north,center,east or south)