[an error occurred while processing this directive]
Overview

Classes


Related Documentation

Getting Started with LiveCycle Mosaic 9.5

Developing Applications for LiveCycle Mosaic 9.5

Using LiveCycle Mosaic 9.5

Upgrading to LiveCycle Mosaic 9.5

ActionScript 3.0 Reference for the Adobe Flash Platform

LiveCycle Mosaic 9.5 XML Schema Reference

LiveCycle Mosaic 9.5 Server Task Reference


Legal Notices

Copyright


Layout


Extends Node.

The Layout class defines the layout to use in creating a panel or view.

Defined in: mosaicDOM.js.

Summary
Constructor Attributes Constructor Name and Description
 
Layout(o)
Constructor.
Method Summary
Method Attributes Method Name and Description
 
Returns the column alignment value of the layout.
 
Returns the width of the columns used in the layout.
 
Returns the horizontal alignment value of the layout.
 
Returns the horizontal gap, that is, the horizontal space between views, panels, or tiles controlled by the layout.
 
Returns the name of the layout.
 
Returns the number of columns included in the layout.
 
Returns the number of rows included in the layout.
 
Returns the orientation value of the layout.
 
Returns the bottom-side padding of the layout.
 
Returns the left-side padding of the layout.
 
Returns the right-side padding value of the layout.
 
Returns the top-side padding of the layout.
 
Returns the number of columns the layout will permit to display at runtime.
 
Returns the number of rows the layout will permit to display at runtime.
 
Returns the row alignment value of the layout.
 
Returns the height of rows used in the layout.
 
Returns the vertical alignment value of the layout.
 
Returns the vertical gap, that is, the vertical space between views, panels, or tiles controlled by the layout.
 
setColumnAlign(columnAlign)
Sets the column alignment of the Layout.
 
setColumnWidth(columnWidth)
Sets the width of columns within the layout.
 
setHorizontalAlign(horizontalAlign)
Sets the horizontal alignment value of the Layout.
 
setHorizontalGap(horizontalGap)
Sets the horizontal gap, that is, the horizontal space between views, panels, or tiles controlled by the layout.
 
setNumColumns(numColumns)
Sets the number of columns to include in the layout.
 
setNumRows(numRows)
Sets the number of rows to include in the layout.
 
setOrientation(orientation)
Sets the orientation, or direction, for the layout.
 
setPaddingBottom(paddingBottom)
Sets the bottom-side padding of the layout.
 
setPaddingLeft(paddingLeft)
Sets the left-side padding of the Layout.
 
setPaddingRight(paddingRight)
Sets the right-side padding of the layout.
 
setPaddingTop(paddingTop)
Sets the top-side padding of the layout.
 
setRequestedColumnCount(requestedColumnCount)
Sets the number of columns to display in the layout at runtime.
 
setRequestedRowCount(requestedRowCount)
Sets the number of rows to display in the layout at runtime.
 
setRowAlign(rowAlign)
Sets the row alignment of the Layout.
 
setRowHeight(rowHeight)
Sets the height of rows within the layout.
 
setVerticalAlign(verticalAlign)
Sets the vertical alignment value of the Layout.
 
setVerticalGap(verticalGap)
Sets the vertical gap, that is, the vertical space between views, panels, or tiles controlled by the layout.
Methods borrowed from class Node:
display, getChildrenNodes, getDisplayed, getNodeId, getNodeLabel, getNodeName, getNodeType, getParentNode, setNodeLabel
Detail
Layout(o)
Constructor. Note: This constructor is for internal use only. Do not use.
Parameters:
o
One of: "AbsoluteLayout", "ColumnLayout", "DynamicColumnLayout", "DynamicRowLayout", "FlowLayout", "HDividedBoxLayout", "HorizontalLayout", "RowLayout", "StackLayout", "TileLayout", "VDividedBoxLayout", and "VerticalLayout".
Method Detail
getColumnAlign()
Returns the column alignment value of the layout. This method applies to the layout TileLayout.
Returns:
One of: "left", "justifyUsingGap", or "justifyUsingWidth".

getColumnWidth()
Returns the width of the columns used in the layout. This method applies to the layout TileLayout.
Returns:
An integer value representing the column width, in pixels.

getHorizontalAlign()
Returns the horizontal alignment value of the layout. This method applies to the layouts HorizontalLayout, VerticalLayout, and TileLayout.
Returns:
One of: "left", "right", "center", or "justify" (TileLayout only).

getHorizontalGap()
Returns the horizontal gap, that is, the horizontal space between views, panels, or tiles controlled by the layout. This method applies to the layouts VerticalLayout, HorizontalLayout, DynamicColumnLayout, DynamicRowLayout, TileLayout, and FlowLayout.
Returns:
An integer value representing the gap space, in pixels.

getName()
Returns the name of the layout.
Returns:
One of: "AbsoluteLayout", "ColumnLayout", "DynamicColumnLayout", "DynamicRowLayout", "FlowLayout", "HDividedBoxLayout", "HorizontalLayout", "RowLayout", "StackLayout", "TileLayout", "VDividedBoxLayout", and "VerticalLayout".

getNumColumns()
Returns the number of columns included in the layout. This method applies to the layout DynamicColumnLayout.
Returns:
An integer representing the number of columns included in the layout.

getNumRows()
Returns the number of rows included in the layout. This method applies to the layout DynamicRowLayout.
Returns:
The number of rows included in the layout.

getOrientation()
Returns the orientation value of the layout. This method applies to the layout TileLayout.
Returns:
One of: "horizontal" or "vertical".

getPaddingBottom()
Returns the bottom-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Returns:
paddingBottom An integer value representing the padding space, in pixels.

getPaddingLeft()
Returns the left-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Returns:
An integer value representing the padding space, in pixels.

getPaddingRight()
Returns the right-side padding value of the layout. This method applies to all layouts except AbsoluteLayout.
Returns:
paddingRight An integer value representing the padding space, in pixels.

getPaddingTop()
Returns the top-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Returns:
An integer value representing the padding space, in pixels.

getRequestedColumnCount()
Returns the number of columns the layout will permit to display at runtime. This method applies to the layout TileLayout.
Returns:
An integer value representing the permitted number of columns to display.

getRequestedRowCount()
Returns the number of rows the layout will permit to display at runtime. This method applies to the layout TileLayout.
Returns:
An integer value representing the permitted number of rows to display.

getRowAlign()
Returns the row alignment value of the layout. This method applies to the layout TileLayout
Returns:
One of: "top", "justifyUsingGap", or "justifyUsingWidth".

getRowHeight()
Returns the height of rows used in the layout. This method applies to the layout TileLayout.
Returns:
An integer value representing row height, in pixels.

getVerticalAlign()
Returns the vertical alignment value of the layout. This method applies to the layouts HorizontalLayout, VerticalLayout, and TileLayout.
Returns:
One of: "top", "bottom", "middle", or "justify" (TileLayout only).

getVerticalGap()
Returns the vertical gap, that is, the vertical space between views, panels, or tiles controlled by the layout. This method applies to the layouts VerticalLayout, HorizontalLayout, DynamicColumnLayout, DynamicRowLayout, TileLayout, and FlowLayout.
Returns:
An integer value representing the gap space, in pixels.

setColumnAlign(columnAlign)
Sets the column alignment of the Layout. This method applies to the layout TileLayout.
Parameters:
columnAlign
One of: "left", "justifyUsingGap", or "justifyUsingWidth".

setColumnWidth(columnWidth)
Sets the width of columns within the layout. This method applies to the layout TileLayout.
Parameters:
columnWidth
An integer value representing the column width, in pixels.

setHorizontalAlign(horizontalAlign)
Sets the horizontal alignment value of the Layout. This method applies to the layouts HorizontalLayout, VerticalLayout, and TileLayout.
Parameters:
horizontalAlign
One of: "left", "right", "center", or "justify" (TileLayout only).

setHorizontalGap(horizontalGap)
Sets the horizontal gap, that is, the horizontal space between views, panels, or tiles controlled by the layout. This method applies to the layouts VerticalLayout, HorizontalLayout, DynamicColumnLayout, DynamicRowLayout, TileLayout, and FlowLayout.
Parameters:
horizontalGap
An integer value representing the gap space, in pixels.

setNumColumns(numColumns)
Sets the number of columns to include in the layout. This method applies to the layout DynamicColumnLayout.
Parameters:
numColumns
An integer value representing the number of columns to include in the layout.

setNumRows(numRows)
Sets the number of rows to include in the layout. This method applies to the layouts DynamicRowLayout.
Parameters:
numRows
An integer value representing the number of rows to include in the layout.

setOrientation(orientation)
Sets the orientation, or direction, for the layout. This method applies to the layout TileLayout.
Parameters:
orientation
One of: "horizontal" or "vertical".

setPaddingBottom(paddingBottom)
Sets the bottom-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Parameters:
paddingBottom
An integer value representing the padding space, in pixels.

setPaddingLeft(paddingLeft)
Sets the left-side padding of the Layout. This method applies to all layouts except AbsoluteLayout.
Parameters:
paddingLeft
An integer value representing the padding space, in pixels.

setPaddingRight(paddingRight)
Sets the right-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Parameters:
paddingRight
An integer value representing the padding space, in pixels.

setPaddingTop(paddingTop)
Sets the top-side padding of the layout. This method applies to all layouts except AbsoluteLayout.
Parameters:
paddingTop
An integer value representing the padding space, in pixels.

setRequestedColumnCount(requestedColumnCount)
Sets the number of columns to display in the layout at runtime. This method applies to the layout TileLayout.
Parameters:
requestedColumnCount
An integer value representing the number of columns to display.

setRequestedRowCount(requestedRowCount)
Sets the number of rows to display in the layout at runtime. This method applies to the layout TileLayout.
Parameters:
requestedRowCount
An integer value representing the number of rows to display.

setRowAlign(rowAlign)
Sets the row alignment of the Layout. This method applies to the layout TileLayout.
Parameters:
rowAlign
One of: "top", "justifyUsingGap", or "justifyUsingWidth".

setRowHeight(rowHeight)
Sets the height of rows within the layout. This method applies to the layout TileLayout.
Parameters:
rowHeight
An integer value representing row height, in pixels.

setVerticalAlign(verticalAlign)
Sets the vertical alignment value of the Layout. This method applies to the layouts HorizontalLayout, VerticalLayout, and TileLayout.
Parameters:
verticalAlign
One of: "top", "bottom","middle" or "justify" (TileLayout only).

setVerticalGap(verticalGap)
Sets the vertical gap, that is, the vertical space between views, panels, or tiles controlled by the layout. This method applies to the layouts VerticalLayout, HorizontalLayout, DynamicColumnLayout, DynamicRowLayout, TileLayout, and FlowLayout.
Parameters:
verticalGap
An integer value representing the gap space, in pixels.

© 2010 Adobe Systems Incorporated. All rights reserved.
October 2010

[an error occurred while processing this directive]