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

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

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

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

The BorderLayoutArea represents one area of a BorderLayout when using the BorderLayout control

• Properties
  • areaId : com.sap.ui.commons.client.layout.BorderLayoutAreaTypes
    Defines which area the element represents. {"top"; "begin"; "center"; "end"; "bottom")
  • overflowX : String
    The overflow mode of the area in horizontal direction (as CSS value)
  • overflowY : String
    The overflow mode of the area in vertical direction (as CSS value)
  • contentAlign : String
    The content alignment (as CSS value)
  • size : String
    Defines the height (North/South) or the width (West/East). Is not used when the area element is in center.
  • visible : boolean
    Controls the area visibility
• Aggregations
  • content : com.sap.ui.core.client.Control
    Controls within the area
• 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.BorderLayoutArea)

Constructor Summary

protected

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

Method Summary

BorderLayoutArea	addContent(com.sap.ui.core.client.Control content) Appends a content to the aggregation content.
static BorderLayoutArea	create() creates a new instance of the class BorderLayoutArea
static BorderLayoutArea	create(String idOrConfig) creates a new instance of the class BorderLayoutArea
static BorderLayoutArea	create(String id, String config) creates a new instance of the class BorderLayoutArea
BorderLayoutArea	destroyContent() Destroys all the content in the Content-aggregation.
BorderLayoutAreaTypes	getAreaId() Getter for property areaId Defines which area the element represents.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getContent() Getter for aggregation content Controls within the area
String	getContentAlign() Getter for property contentAlign The content alignment (as CSS value)
String	getOverflowX() Getter for property overflowX The overflow mode of the area in horizontal direction (as CSS value)
String	getOverflowY() Getter for property overflowY The overflow mode of the area in vertical direction (as CSS value)
String	getSize() Getter for property size Defines the height (North/South) or the width (West/East).
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.
BorderLayoutArea	insertContent(com.sap.ui.core.client.Control content, int index) Inserts some content into the aggregation named content.
boolean	isVisible() Getter for property visible Controls the area visibility
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.
BorderLayoutArea	setAreaId(BorderLayoutAreaTypes value) Setter for property areaId Default value is: top
BorderLayoutArea	setContentAlign(String value) Setter for property contentAlign Default value is: left
BorderLayoutArea	setOverflowX(String value) Setter for property overflowX Default value is: auto
BorderLayoutArea	setOverflowY(String value) Setter for property overflowY Default value is: auto
BorderLayoutArea	setSize(String value) Setter for property size Default value is: 100px
BorderLayoutArea	setVisible(boolean value) Setter for property visible Default value is: true
void	setVisible(boolean visible, com.sap.ui.core.client.Control borderLayout) Setter for property visible.

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

BorderLayoutArea

protected BorderLayoutArea()

constructs the class BorderLayoutArea
hidden due to JavaScriptObject restriction

Method Detail

create

public static BorderLayoutArea create()

creates a new instance of the class BorderLayoutArea

create

public static BorderLayoutArea create(String idOrConfig)

creates a new instance of the class BorderLayoutArea

Parameters:

id - id of the BorderLayoutArea or configuration JSON string

create

public static BorderLayoutArea create(String id,
                                      String config)

creates a new instance of the class BorderLayoutArea

Parameters:

id - id of the BorderLayoutArea

config - configuration JSON string

getAreaId

public final BorderLayoutAreaTypes getAreaId()

Getter for property areaId Defines which area the element represents. {"top"; "begin"; "center"; "end"; "bottom")

Returns:

the value of property areaId

setAreaId

public final BorderLayoutArea setAreaId(BorderLayoutAreaTypes value)

Setter for property areaId
Default value is: top

Parameters:

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

Returns:

this to allow method chaining

getOverflowX

public final String getOverflowX()

Getter for property overflowX The overflow mode of the area in horizontal direction (as CSS value)

Returns:

the value of property overflowX

setOverflowX

public final BorderLayoutArea setOverflowX(String value)

Setter for property overflowX
Default value is: auto

Parameters:

value - String

Returns:

this to allow method chaining

getOverflowY

public final String getOverflowY()

Getter for property overflowY The overflow mode of the area in vertical direction (as CSS value)

Returns:

the value of property overflowY

setOverflowY

public final BorderLayoutArea setOverflowY(String value)

Setter for property overflowY
Default value is: auto

Parameters:

value - String

Returns:

this to allow method chaining

getContentAlign

public final String getContentAlign()

Getter for property contentAlign The content alignment (as CSS value)

Returns:

the value of property contentAlign

setContentAlign

public final BorderLayoutArea setContentAlign(String value)

Setter for property contentAlign
Default value is: left

Parameters:

value - String

Returns:

this to allow method chaining

getSize

public final String getSize()

Getter for property size Defines the height (North/South) or the width (West/East). Is not used when the area element is in center.

Returns:

the value of property size

setSize

public final BorderLayoutArea setSize(String value)

Setter for property size
Default value is: 100px

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Controls the area visibility

Returns:

the value of property visible

setVisible

public final BorderLayoutArea setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

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 Controls within the area

Returns:

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

insertContent

public final BorderLayoutArea 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 BorderLayoutArea 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 BorderLayoutArea destroyContent()

Destroys all the content in the Content-aggregation.

Returns:

this to allow method chaining

setVisible

public final void setVisible(boolean visible,
                             com.sap.ui.core.client.Control borderLayout)

Setter for property visible. Optionally a vanish/appearance-sliding animation is shown

Parameters:

visible - new value for property visible

borderLayout - OPTIONAL. When the corresponding BorderLayout control of the area is submitted a slide animation will be shown