Class Index | File Index

Classes


Class mindmaps.FloatPanel


Defined in: FloatPanel.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
mindmaps.FloatPanel(caption, $container, $content)
A reusable, draggable panel gui element.
Field Summary
Field Attributes Field Name and Description
<private>  
Method Summary
Method Attributes Method Name and Description
 
Clears the content of the panel.
<private>  
Moves panel into view port if position exceeds the bounds of the container.
 
 
hide()
Hides the panel.
 
 
setContent($content)
Replaces the content in the panel.
 
setHideTarget($target)
Sets the hide target for the panel.
 
Sets the position of the panel relative to the container.
 
show()
Shows the panel.
 
Shows or hides the panel.
<private>  
transfer($from, $to)
Shows a transfer effect.
 
Class Detail
mindmaps.FloatPanel(caption, $container, $content)
A reusable, draggable panel gui element. The panel is contained within the container. When a $hideTarget is set, the hide/show animations will show a transfer effect.
Parameters:
{String} caption
the float panel title
{jQuery} $container
the surrounding container jquery object
{jQuery} $content
the content as a jquery object
Field Detail
<private> $widget
Method Detail
clearContent()
Clears the content of the panel.

<private> ensurePosition()
Moves panel into view port if position exceeds the bounds of the container.

{Number} height()
Returns:
{Number} the height.

hide()
Hides the panel. Will show transfer effect if $hideTarget is set.

{Object} offset()
Returns:
{Object} the offset

setContent($content)
Replaces the content in the panel.
Parameters:
{jQuery} $content

setHideTarget($target)
Sets the hide target for the panel.
Parameters:
{jQuery} $target

setPosition(x, y)
Sets the position of the panel relative to the container.
Parameters:
{Number} x
{Number} y

show()
Shows the panel. Will show transfer effect if $hideTarget is set.

toggle()
Shows or hides the panel.

<private> transfer($from, $to)
Shows a transfer effect.
Parameters:
{jQuery} $from
{jQuery} $to

{Number} width()
Returns:
{Number} the width.

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jul 18 2011 18:03:15 GMT+0000 (WEST)