com.sap.ui.commons.client.layout
Class MatrixLayoutCell

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.commons.client.layout.MatrixLayoutCell

public class MatrixLayoutCell
extends com.sap.ui.core.client.Element

The class MatrixLayoutCell is the GWT wrapper for the Phoenix control: sap.ui.commons.layout.MatrixLayoutCell.

Non-control element used as part of a matrix layout's inner structure.

• Properties
  • backgroundDesign : com.sap.ui.commons.client.layout.BackgroundDesign
    Determines the matrix layout cell's background design.
  • colSpan : int
    Determines how many columns of the underlying grid structure are occupied by this matrix layout cell.
  • hAlign : com.sap.ui.commons.client.layout.HAlign
    Determines the horizontal alignment of the matrix layout cell's content with the cell's borders.
  • padding : com.sap.ui.commons.client.layout.Padding
    Determines the padding of the matrix layout cell's content within the cell's borders. The default value is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout in case of nesting.
  • rowSpan : int
    Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In case a row-height is used, all rows affected by the RowSpan must have the same unit.
  • separation : com.sap.ui.commons.client.layout.Separation
    Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable width, with or without a vertical line.
  • vAlign : com.sap.ui.commons.client.layout.VAlign
    Determines the vertical alignment of the matrix layout cell's content with the cell's borders.
• Aggregations
  • content : com.sap.ui.core.client.Control
    The matrix layout cell's content (arbitrary controls). If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of a cell should all use the same unit for its height property.
• Associations
• Events

For further parameters see {@link com.sap.ui.core.client.Element

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.layout.MatrixLayoutCell)

Constructor Summary

protected

MatrixLayoutCell() constructs the class MatrixLayoutCell hidden due to JavaScriptObject restriction

Method Summary

MatrixLayoutCell	addContent(com.sap.ui.core.client.Control content) Appends a content to the aggregation content.
static MatrixLayoutCell	create() creates a new instance of the class MatrixLayoutCell
static MatrixLayoutCell	create(String idOrConfig) creates a new instance of the class MatrixLayoutCell
static MatrixLayoutCell	create(String id, String config) creates a new instance of the class MatrixLayoutCell
MatrixLayoutCell	destroyContent() Destroys all the content in the Content-aggregation.
BackgroundDesign	getBackgroundDesign() Getter for property backgroundDesign Determines the matrix layout cell's background design.
int	getColSpan() Getter for property colSpan Determines how many columns of the underlying grid structure are occupied by this matrix layout cell.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getContent() Getter for aggregation content The matrix layout cell's content (arbitrary controls).
HAlign	getHAlign() Getter for property hAlign Determines the horizontal alignment of the matrix layout cell's content with the cell's borders.
Padding	getPadding() Getter for property padding Determines the padding of the matrix layout cell's content within the cell's borders.
int	getRowSpan() Getter for property rowSpan Determines how many rows of the underlying grid structure are occupied by this matrix layout cell.
Separation	getSeparation() Getter for property separation Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable width, with or without a vertical line.
VAlign	getVAlign() Getter for property vAlign Determines the vertical alignment of the matrix layout cell's content with the cell's borders.
int	indexOfContent(com.sap.ui.core.client.Control content) Checks for the provided com.sap.ui.core.client.Control in the content-aggregation and returns its index if found or -1 otherwise.
MatrixLayoutCell	insertContent(com.sap.ui.core.client.Control content, int index) Inserts some content into the aggregation named content.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>>	removeAllContent() Removes all the items in the content-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeContent(int index) Removes a content from the aggregation named content.
MatrixLayoutCell	setBackgroundDesign(BackgroundDesign value) Setter for property backgroundDesign Default value is: 'Transparent'
MatrixLayoutCell	setColSpan(int value) Setter for property colSpan Default value is: 1
MatrixLayoutCell	setHAlign(HAlign value) Setter for property hAlign Default value is: 'Begin'
MatrixLayoutCell	setPadding(Padding value) Setter for property padding Default value is: 'End'
MatrixLayoutCell	setRowSpan(int value) Setter for property rowSpan Default value is: 1
MatrixLayoutCell	setSeparation(Separation value) Setter for property separation Default value is: 'None'
MatrixLayoutCell	setVAlign(VAlign value) Setter for property vAlign Default value is: 'Middle'

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MatrixLayoutCell

protected MatrixLayoutCell()

constructs the class MatrixLayoutCell
hidden due to JavaScriptObject restriction

Method Detail

create

public static MatrixLayoutCell create()

creates a new instance of the class MatrixLayoutCell

create

public static MatrixLayoutCell create(String idOrConfig)

creates a new instance of the class MatrixLayoutCell

Parameters:

id - id of the MatrixLayoutCell or configuration JSON string

create

public static MatrixLayoutCell create(String id,
                                      String config)

creates a new instance of the class MatrixLayoutCell

Parameters:

id - id of the MatrixLayoutCell

config - configuration JSON string

getBackgroundDesign

public final BackgroundDesign getBackgroundDesign()

Getter for property backgroundDesign Determines the matrix layout cell's background design.

Returns:

the value of property backgroundDesign

setBackgroundDesign

public final MatrixLayoutCell setBackgroundDesign(BackgroundDesign value)

Setter for property backgroundDesign
Default value is: 'Transparent'

Parameters:

value - com.sap.ui.commons.client.layout.BackgroundDesign

Returns:

this to allow method chaining

getColSpan

public final int getColSpan()

Getter for property colSpan Determines how many columns of the underlying grid structure are occupied by this matrix layout cell.

Returns:

the value of property colSpan

setColSpan

public final MatrixLayoutCell setColSpan(int value)

Setter for property colSpan
Default value is: 1

Parameters:

value - int

Returns:

this to allow method chaining

getHAlign

public final HAlign getHAlign()

Getter for property hAlign Determines the horizontal alignment of the matrix layout cell's content with the cell's borders.

Returns:

the value of property hAlign

setHAlign

public final MatrixLayoutCell setHAlign(HAlign value)

Setter for property hAlign
Default value is: 'Begin'

Parameters:

value - com.sap.ui.commons.client.layout.HAlign

Returns:

this to allow method chaining

getPadding

public final Padding getPadding()

Getter for property padding Determines the padding of the matrix layout cell's content within the cell's borders. The default value is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout in case of nesting.

Returns:

the value of property padding

setPadding

public final MatrixLayoutCell setPadding(Padding value)

Setter for property padding
Default value is: 'End'

Parameters:

value - com.sap.ui.commons.client.layout.Padding

Returns:

this to allow method chaining

getRowSpan

public final int getRowSpan()

Getter for property rowSpan Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In case a row-height is used, all rows affected by the RowSpan must have the same unit.

Returns:

the value of property rowSpan

setRowSpan

public final MatrixLayoutCell setRowSpan(int value)

Setter for property rowSpan
Default value is: 1

Parameters:

value - int

Returns:

this to allow method chaining

getSeparation

public final Separation getSeparation()

Getter for property separation Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable width, with or without a vertical line.

Returns:

the value of property separation

setSeparation

public final MatrixLayoutCell setSeparation(Separation value)

Setter for property separation
Default value is: 'None'

Parameters:

value - com.sap.ui.commons.client.layout.Separation

Returns:

this to allow method chaining

getVAlign

public final VAlign getVAlign()

Getter for property vAlign Determines the vertical alignment of the matrix layout cell's content with the cell's borders.

Returns:

the value of property vAlign

setVAlign

public final MatrixLayoutCell setVAlign(VAlign value)

Setter for property vAlign
Default value is: 'Middle'

Parameters:

value - com.sap.ui.commons.client.layout.VAlign

Returns:

this to allow method chaining

getContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> getContent()

Getter for aggregation content The matrix layout cell's content (arbitrary controls). If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of a cell should all use the same unit for its height property.

Returns:

com.sap.ui.core.client.Control[]

insertContent

public final MatrixLayoutCell insertContent(com.sap.ui.core.client.Control content,
                                            int index)

Inserts some content into the aggregation named content.

Parameters:

content - the content to insert

index - int the 0-based index the content should be inserted at.

Returns:

this to allow method chaining

addContent

public final MatrixLayoutCell addContent(com.sap.ui.core.client.Control content)

Appends a content to the aggregation content.

Parameters:

content - com.sap.ui.core.client.Control the content to add

Returns:

this to allow method chaining

removeContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> removeContent(int index)

Removes a content from the aggregation named content.

Parameters:

index - int the position of the content to remove.

Returns:

reference to this instance

removeAllContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>> removeAllContent()

Removes all the items in the content-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfContent

public final int indexOfContent(com.sap.ui.core.client.Control content)

Checks for the provided com.sap.ui.core.client.Control in the content-aggregation and returns its index if found or -1 otherwise.

Parameters:

content - the content whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyContent

public final MatrixLayoutCell destroyContent()

Destroys all the content in the Content-aggregation.

Returns:

this to allow method chaining