dojox/layout/GridContainerLite.js

• Provides:

  • dojox.layout.GridContainerLite

• Requires:

  • dijit._Templated in common
  • dijit.layout._LayoutWidget in common
  • dojox.mdnd.AreaManager in common
  • dojox.mdnd.DropIndicator in common
  • dojox.mdnd.dropMode.OverDropMode in common
  • dojox.mdnd.AutoScroll in common

• dijit._Widget

  • type

    Function

• dijit._Widget.column

  • type

    String

  • summary

    Column of the grid to place the widget.
    Defined only if dojo.require("dojox.layout.GridContainerLite") is done.

• dijit._Widget.dragRestriction

  • type

    Boolean

  • summary

    If true, the widget can not be draggable.
    Defined only if dojo.require("dojox.layout.GridContainerLite") is done.

• dojox.layout.GridContainerLite

  • type

    Function

  • chains:
    • dijit.layout._LayoutWidget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit.layout._LayoutWidget: (call)
    • dijit._Templated: (call)
  • parameters:
    • props: (typeof Object)
    • node: (typeof DOMNode)
  • summary

    The GridContainerLite is a container of child elements that are placed in a kind of grid.

  • description

    GridContainerLite displays the child elements by column
    (ie: the children widths are fixed by the column width of the grid but
    the children heights are free).
    Each child is movable by drag and drop inside the GridContainer.
    The position of other children is automatically calculated when a child is moved.

  • example

    	<div dojoType="dojox.layout.GridContainerLite" nbZones="3" isAutoOrganized="true">
    		<div dojoType="dijit.layout.ContentPane">Content Pane 1 : Drag Me !</div>
    		<div dojoType="dijit.layout.ContentPane">Content Pane 2 : Drag Me !</div>
    		<div dojoType="dijit.layout.ContentPane">Content Pane 3 : Drag Me !</div>
    	</div>

  • example

    	dojo.ready(function(){
    		var cpane1 = new dijit.layout.ContentPane({
    			title:"cpane1", content: "Content Pane 1 : Drag Me !"
    		}),
    		cpane2 = new dijit.layout.ContentPane({
    			title:"cpane2",
    			content: "Content Pane 2 : Drag Me !"
    		}),
    		cpane3 = new dijit.layout.ContentPane({
    			title:"cpane3",
    			content: "Content Pane 3 : Drag Me !"
    		});
    
    		var widget = new dojox.layout.GridContainerLite({
    			nbZones: 3,
    			isAutoOrganized: true
    		}, dojo.byId("idNode"));
    		widget.addChild(cpane1, 0, 0);
    		widget.addChild(cpane2, 1, 0);
    		widget.addChild(cpane3, 2, 1);
    		widget.startup();
    	});

• dojox.layout.GridContainerLite.autoRefresh

  • type

    Boolean

  • summary

    Enable the refresh of registered areas on drag start.

• dojox.layout.GridContainerLite.templateString

  • type

    String

  • summary

    template of gridContainer.

• dojox.layout.GridContainerLite.dragHandleClass

  • type

    Array

  • summary

    :
    CSS class enabling a drag handle on a child.

• dojox.layout.GridContainerLite.nbZones

  • type

    Integer

  • summary

    The number of dropped zones, by default 1.

• dojox.layout.GridContainerLite.doLayout

  • type

    Boolean

  • summary

    If true, change the size of my currently displayed child to match my size.

• dojox.layout.GridContainerLite.isAutoOrganized

  • type

    Boolean

  • summary

    If true, widgets are organized automatically,
    else the attribute colum of child will define the right column.

• dojox.layout.GridContainerLite.acceptTypes

  • type

    Array

  • summary

    The GridContainer will only accept the children that fit to the types.

• dojox.layout.GridContainerLite.colWidths

  • type

    String

  • summary

    A comma separated list of column widths. If the column widths do not add up
    to 100, the remaining columns split the rest of the width evenly
    between them.

• dojox.layout.GridContainerLite.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • props: (typeof Object)
    • node: (typeof DOMNode)

• dojox.layout.GridContainerLite.postCreate

  • type

    Function

• dojox.layout.GridContainerLite._grid

  • type

    Array

• dojox.layout.GridContainerLite._dragManager

  • type

    Object

• dojox.layout.GridContainerLite._dragManager.autoRefresh

• dojox.layout.GridContainerLite._dragManager.dragHandleClass

• dojox.layout.GridContainerLite._border

  • type

    Object

• dojox.layout.GridContainerLite.startup

  • type

    Function

• dojox.layout.GridContainerLite.resizeChildAfterDrop

  • parameters:
    • node: (typeof Node)

      domNode of dropped widget.

    • targetArea: (typeof Object)

      AreaManager Object containing information of targetArea

    • indexChild: (typeof Integer)

      Index where the dropped widget has been placed

  • summary

    Resize the GridContainerLite inner table and the dropped widget.

  • description

    These components are resized only if the targetArea.node is a
    child of this instance of gridContainerLite.
    To be resized, the dropped node must have also a method resize.

  • return_summary

    True if resized.

  • type

    Function

• dojox.layout.GridContainerLite._contentBox.h

• dojox.layout.GridContainerLite.resizeChildAfterDragStart

  • parameters:
    • node: (typeof Node)

      domNode of dragged widget.

    • sourceArea: (typeof Object)

      AreaManager Object containing information of sourceArea

    • indexChild: (typeof Integer)

      Index where the dragged widget has been placed

  • summary

    Resize the GridContainerLite inner table only if the drag source
    is a child of this gridContainer.

  • type

    Function

• dojox.layout.GridContainerLite._draggedNode

• dojox.layout.GridContainerLite.getChildren

  • returns

    Array

  • summary

    A specific method which returns children after they were placed in zones.

  • return_summary

    An array containing all children (widgets).

  • tags:
  • type

    Function

• dojox.layout.GridContainerLite._isShown

  • returns

    Boolean

  • summary

    Check if the domNode is visible or not.

  • return_summary

    true if the content is currently shown

  • tags:
  • type

    Function

• dojox.layout.GridContainerLite.domNode

• dojox.layout.GridContainerLite.layout

  • summary

    Resize of each child

  • type

    Function

• dojox.layout.GridContainerLite._contentBox

• dojox.layout.GridContainerLite.onShow

  • summary

    Enabled the Drag And Drop if it's necessary.

  • type

    Function

• dojox.layout.GridContainerLite.onHide

  • summary

    Disabled the Drag And Drop if it's necessary.

  • type

    Function

• dojox.layout.GridContainerLite._createCells

  • summary

    Create the columns of the GridContainer.

  • tags:
  • type

    Function

• dojox.layout.GridContainerLite._getZonesAttr

  • summary

    return array of zone (domNode)

  • type

    Function

• dojox.layout.GridContainerLite.enableDnd

  • summary

    Enable the Drag And Drop for children of GridContainer.

  • type

    Function

• dojox.layout.GridContainerLite._disabled

  • type

    Object

• dojox.layout.GridContainerLite.disableDnd

  • summary

    Disable the Drag And Drop for children of GridContainer.

  • type

    Function

• dojox.layout.GridContainerLite._organizeChildren

  • summary

    List all zones and insert child into columns.

  • type

    Function

• dojox.layout.GridContainerLite._organizeChildrenManually

  • summary

    Organize children by column property of widget.

  • type

    Function

• dojox.layout.GridContainerLite._insertChild

  • parameters:
    • child: (typeof Widget)
    • column: (typeof Integer)

      Column number

    • p: (typeof Integer)

      Place in the zone (0 - first)

  • returns

    Widget

  • summary

    Insert a child in a specific column of the GridContainer widget.

  • return_summary

    The widget inserted

  • type

    Function

• dojox.layout.GridContainerLite.removeChild

  • parameters:
    • widget: (typeof Widget)
  • type

    Function

• dojox.layout.GridContainerLite.addService

  • parameters:
    • child: (typeof Object)
    • column: (typeof Integer)
    • p: (typeof Integer)
  • type

    Function

• dojox.layout.GridContainerLite.addChild

  • parameters:
    • child: (typeof Object)

      widget to insert

    • column: (typeof Integer)

      column number

    • p: (typeof Integer)

      place in the zone (first = 0)

  • returns

    Widget

  • summary

    Add a child in a specific column of the GridContainer widget.

  • return_summary

    The widget inserted

  • type

    Function

• dojox.layout.GridContainerLite._setColWidthsAttr

  • parameters:
    • value
  • type

    Function

• dojox.layout.GridContainerLite._updateColumnsWidth

  • parameters:
    • manager: (typeof Object)

      dojox.mdnd.AreaManager singleton

  • summary

    Update the columns width.

  • tags:
  • type

    Function

• dojox.layout.GridContainerLite._grid.length

• dojox.layout.GridContainerLite._selectFocus

  • parameters:
    • event: (typeof Event)
  • summary

    Enable keyboard accessibility into the GridContainer.

  • description

    Possibility to move focus into the GridContainer (TAB, LEFT ARROW, RIGHT ARROW, UP ARROW, DOWN ARROW).
    Possibility to move GridContainer's children (Drag and Drop) with keyboard. (SHIFT +  ARROW).
    If the type of widget is not draggable, a popup is displayed.

  • type

    Function

• dojox.layout.GridContainerLite.gridNode.childNodes

• dojox.layout.GridContainerLite.destroy

  • type

    Function

• dojox.layout

  • type

    Object

• dojox

  • type

    Object