dojox/layout/FloatingPane.js

• Provides:

  • dojox.layout.FloatingPane

• Requires:

  • dojo.window in common
  • dijit._Templated in common
  • dijit._Widget in common
  • dojo.dnd.Moveable in common
  • dojox.layout.ContentPane in common
  • dojox.layout.ResizeHandle in common

• dojox.layout.FloatingPane

  • type

    Function

  • chains:
    • dojox.layout.ContentPane: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dojox.layout.ContentPane: (call)
    • dijit._Templated: (call)
  • summary

    A non-modal Floating window.

  • description

    Makes a `dojox.layout.ContentPane` float and draggable by it's title [similar to TitlePane]
    and over-rides onClick to onDblClick for wipeIn/Out of containerNode
    provides minimize(dock) / show() and hide() methods, and resize [almost]

• dojox.layout.FloatingPane.closable

  • type

    Boolean

  • summary

    Allow closure of this Node

• dojox.layout.FloatingPane.dockable

  • type

    Boolean

  • summary

    Allow minimizing of pane if true

• dojox.layout.FloatingPane.resizable

  • type

    Boolean

  • summary

    Allow resizing of pane true if true

• dojox.layout.FloatingPane.maxable

  • type

    Boolean

  • summary

    Horrible param name for "Can you maximize this floating pane?"

• dojox.layout.FloatingPane.resizeAxis

  • type

    String

  • summary

    One of: x | xy | y to limit pane's sizing direction

• dojox.layout.FloatingPane.title

  • type

    String

  • summary

    Title to use in the header

• dojox.layout.FloatingPane.dockTo

  • optional
  • type

    DomNode

  • summary

    if empty, will create private layout.Dock that scrolls with viewport
    on bottom span of viewport.

• dojox.layout.FloatingPane.duration

  • type

    Integer

  • summary

    Time is MS to spend toggling in/out node

• dojox.layout.FloatingPane.iconSrc

  • type

    String

  • summary

    [not implemented yet] will be either icon in titlepane to left
    of Title, and/or icon show when docked in a fisheye-like dock
    or maybe dockIcon would be better?

• dojox.layout.FloatingPane.contentClass

  • type

    String

  • summary

    The className to give to the inner node which has the content

• dojox.layout.FloatingPane._showAnim

  • type

    Object

• dojox.layout.FloatingPane._hideAnim

  • type

    Object

• dojox.layout.FloatingPane._dockNode

  • type

    Object

• dojox.layout.FloatingPane._restoreState

  • type

    Object

• dojox.layout.FloatingPane._allFPs

  • type

    Array

• dojox.layout.FloatingPane._startZ

  • type

    Number

• dojox.layout.FloatingPane.templateString

  • type

    Object

• dojox.layout.FloatingPane.attributeMap

  • type

    Object

• dojox.layout.FloatingPane.postCreate

  • type

    Function

• dojox.layout.FloatingPane.dockNode.style.display

  • type

    String

• dojox.layout.FloatingPane.closeNode.style.display

  • type

    String

• dojox.layout.FloatingPane.maxNode.style.display

  • type

    String

• dojox.layout.FloatingPane.restoreNode.style.display

  • type

    String

• dojox.layout.FloatingPane.resizeHandle.style.display

  • type

    String

• dojox.layout.FloatingPane.domNode.style.width

  • type

    String

• dojox.layout.FloatingPane.domNode.style.position

  • type

    String

• dojox.layout.FloatingPane.bgIframe

  • type

    Object

• dojox.layout.FloatingPane._naturalState

  • type

    Object

• dojox.layout.FloatingPane.startup

  • type

    Function

• dojox.layout.FloatingPane.canvas.style.overflow

  • type

    String

• dojox.layout.FloatingPane.containerNode.style.overflow

  • type

    String

• dojox.layout.FloatingPane._resizeHandle

  • type

    Object

• dojox.layout.FloatingPane._started

  • type

    Object

• dojox.layout.FloatingPane.setTitle

  • parameters:
    • title: (typeof String)
  • summary

    Update the Title bar with a new string

  • type

    Function

• dojox.layout.FloatingPane.close

  • summary

    Close and destroy this widget

  • type

    Function

• dojox.layout.FloatingPane.hide

  • parameters:
    • callback: (typeof Function)
  • summary

    Close, but do not destroy this FloatingPane

  • type

    Function

• dojox.layout.FloatingPane.show

  • parameters:
    • callback: (typeof Function)
  • summary

    Show the FloatingPane

  • type

    Function

• dojox.layout.FloatingPane.minimize

  • summary

    Hide and dock the FloatingPane

  • type

    Function

• dojox.layout.FloatingPane.maximize

  • summary

    Make this FloatingPane full-screen (viewport)

  • type

    Function

• dojox.layout.FloatingPane._maximized

  • type

    bool

• dojox.layout.FloatingPane._restore

  • type

    Function

• dojox.layout.FloatingPane._dock

  • type

    Function

• dojox.layout.FloatingPane._isDocked

  • type

    Object

• dojox.layout.FloatingPane.resize

  • parameters:
    • dim: (typeof Object)
  • summary

    Size the FloatingPane and place accordingly

  • type

    Function

• dojox.layout.FloatingPane._currentState

• dojox.layout.FloatingPane.domNode.style

• dojox.layout.FloatingPane.domNode.style.top

  • type

    String

• dojox.layout.FloatingPane.domNode.style.left

  • type

    String

• dojox.layout.FloatingPane.domNode.style.height

  • type

    String

• dojox.layout.FloatingPane.bringToTop

  • summary

    bring this FloatingPane above all other panes

  • type

    Function

• dojox.layout.FloatingPane.destroy

  • summary

    Destroy this FloatingPane completely

  • type

    Function

• dojox.layout.Dock

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A widget that attaches to a node and keeps track of incoming / outgoing FloatingPanes
    and handles layout

• dojox.layout.Dock.templateString

  • type

    String

• dojox.layout.Dock._docked

  • type

    Array

• dojox.layout.Dock._inPositioning

  • type

    bool

• dojox.layout.Dock.autoPosition

  • type

    bool

• dojox.layout.Dock.addNode

  • parameters:
    • refNode
  • summary

    Instert a dockNode refernce into the dock

  • type

    Function

• dojox.layout.Dock.startup

  • type

    Function

• dojox.layout.Dock._positionDock

  • parameters:
    • e: (typeof Event)
  • type

    Function

• dojox.layout._DockNode

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    dojox.layout._DockNode is a private widget used to keep track of
    which pane is docked.

• dojox.layout._DockNode.title

  • type

    String

  • summary

    Shown in dock icon. should read parent iconSrc?

• dojox.layout._DockNode.paneRef

  • type

    Widget

  • summary

    reference to the FloatingPane we reprasent in any given dock

• dojox.layout._DockNode.templateString

  • type

    String

• dojox.layout._DockNode.restore

  • summary

    remove this dock item from parent dock, and call show() on reffed floatingpane

  • type

    Function

• dojox.layout

  • type

    Object

• dojox

  • type

    Object