dojox/widget/Portlet.js

• Provides:

  • dojox.widget.Portlet

• Requires:

  • dijit.TitlePane in common
  • dojo.fx in common

• dojox.widget.Portlet

  • type

    Function

  • chains:
    • dijit.TitlePane: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit.TitlePane: (call)
    • dijit._Container: (call)
  • summary

    A container widget that is designed to be contained
    in a dojox.layout.GridContainer. Child widgets can insert
    an icon into the title bar of the Portlet, which when
    clicked, executes the "toggle" method of the child widget.
    A child widget must specify the attribute
    "portletIconClass", and the optional class
    "portletIconHoverClass", as well as the
    "toggle" function.

• dojox.widget.Portlet.resizeChildren

  • type

    Boolean

  • summary

    If true, when the Portlet is resized, any child widgets
    with a 'resize' method have that method called.

• dojox.widget.Portlet.closable

  • type

    Boolean

  • summary

    If true, a close button is placed in the title bar,
    and the Portlet can be hidden. If false, the Portlet
    cannot be closed.

• dojox.widget.Portlet._parents

  • type

    Array

  • summary

    An array of all the StackContainer widgets that this Portlet
    is contained in.	These are used to determine if the portlet
    is visible or not.

• dojox.widget.Portlet._size

  • type

    Object

  • summary

    Cache of the previous size of the portlet, used to determine
    if the size has changed and if the child widgets should be
    resized.

• dojox.widget.Portlet.dragRestriction

  • type

    Boolean

  • summary

    To remove the drag capability.

• dojox.widget.Portlet.buildRendering

  • type

    Function

• dojox.widget.Portlet.postCreate

  • type

    Function

• dojox.widget.Portlet.closeIcon

  • type

    Object

• dojox.widget.Portlet.startup

  • type

    Function

• dojox.widget.Portlet._placeSettingsWidgets

  • summary

    Checks all the children to see if they are instances
    of dojox.widget.PortletSettings. If they are,
    create an icon for them in the title bar which when clicked,
    calls their toggle() method.

  • type

    Function

• dojox.widget.Portlet._createIcon

  • parameters:
    • clazz
    • hoverClazz
    • fn
  • summary

    creates an icon in the title bar.

  • type

    Function

• dojox.widget.Portlet.onClose

  • parameters:
    • evt
  • summary

    Hides the portlet. Note that it does not
    persist this, so it is up to the client to
    listen to this method and persist the closed state
    in their own way.

  • type

    Function

• dojox.widget.Portlet.onSizeChange

  • parameters:
    • widget
  • summary

    Updates the Portlet size if any other Portlet
    changes its size.

  • type

    Function

• dojox.widget.Portlet._updateSize

  • summary

    Updates the size of all child widgets.

  • type

    Function

• dojox.widget.Portlet._timer

  • type

    Object

• dojox.widget.Portlet.onUpdateSize

  • summary

    Stub function called when the size is changed.

  • type

    Function

• dojox.widget.Portlet._publish

  • summary

    Publishes an event that all other portlets listen to.
    This causes them to update their child widgets if their
    size has changed.

  • type

    Function

• dojox.widget.Portlet._onTitleClick

  • parameters:
    • evt
  • type

    Function

• dojox.widget.Portlet.addChild

  • parameters:
    • child
  • summary

    Adds a child widget to the portlet.

  • type

    Function

• dojox.widget.Portlet.destroyDescendants

  • parameters:
    • preserveDom: (typeof Boolean)
  • type

    Function

• dojox.widget.Portlet.destroy

  • type

    Function

• dojox.widget.Portlet._setCss

  • type

    Function

• dojox.widget.PortletSettings

  • type

    Function

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

    A settings widget to be used with a dojox.widget.Portlet.

  • description

    This widget should be placed inside a dojox.widget.Portlet widget.
    It is used to set some preferences for that Portlet.	It is essentially
    a ContentPane, and should contain other widgets and DOM nodes that
    do the real work of setting preferences for the portlet.

• dojox.widget.PortletSettings.portletIconClass

  • type

    String

  • summary

    The CSS class to apply to the icon in the Portlet title bar that is used
    to toggle the visibility of this widget.

• dojox.widget.PortletSettings.portletIconHoverClass

  • type

    String

  • summary

    The CSS class to apply to the icon in the Portlet title bar that is used
    to toggle the visibility of this widget when the mouse hovers over it.

• dojox.widget.PortletSettings.postCreate

  • summary

    Sets the require CSS classes on the widget.

  • type

    Function

• dojox.widget.PortletSettings._setPortletAttr

  • parameters:
    • portlet
  • summary

    Sets the portlet that encloses this widget.

  • type

    Function

• dojox.widget.PortletSettings.portlet

• dojox.widget.PortletSettings.toggle

  • summary

    Toggles the visibility of this widget.

  • type

    Function

• dojox.widget.PortletSettings.domNode

• dojox.widget.PortletDialogSettings

  • type

    Function

  • chains:
    • dojox.widget.PortletSettings: (prototype)
    • dojox.widget.PortletSettings: (call)
  • parameters:
    • props
    • node
  • summary

    A settings widget to be used with a dojox.widget.Portlet, which displays
    the contents of this widget in a dijit.Dialog box.

• dojox.widget.PortletDialogSettings.dimensions

  • type

    Array

  • summary

    The size of the dialog to display.	This defaults to [300, 300]

• dojox.widget.PortletDialogSettings.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • props
    • node

• dojox.widget.PortletDialogSettings.toggle

  • summary

    Shows and hides the Dialog box.

  • type

    Function

• dojox.widget.PortletDialogSettings.dialog

  • type

    Object

• dojox.widget

  • type

    Object

• dojox

  • type

    Object