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

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

public class BorderLayout
extends com.sap.ui.core.client.Control

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

A BorderLayout control based upon the JAVA border-layout. With this layout you are able to divide your available space into 5 areas whose sizes can be defined. The 5 areas are: Top: Header; Bottom: Footer; Begin: left/right handed side panel; Center: content area in the middle; End: right/left handed side panel.

• Properties
  • rtl : boolean
    RTL will rotate the begin and end areas.
  • width : String
    Defines the width of the BorderLayout
  • height : String
    Defines the height of the BorderLayout
• Aggregations
  • top : com.sap.ui.core.client.Element
    Represents the top area
  • begin : com.sap.ui.core.client.Element
    Represents the begin area
  • center : com.sap.ui.core.client.Element
    Represents the center area
  • end : com.sap.ui.core.client.Element
    Represents the end area
  • bottom : com.sap.ui.core.client.Element
    Represents the bottom area
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

void	addContent(String areaId, com.sap.ui.core.client.Control controls) Adds controls to the specified area.
static BorderLayout	create() creates a new instance of the class BorderLayout
static BorderLayout	create(String idOrConfig) creates a new instance of the class BorderLayout
static BorderLayout	create(String id, String config) creates a new instance of the class BorderLayout
com.sap.ui.core.client.Element	createArea(String areaId, com.sap.ui.core.client.Control controls) Creates the specified area and adds the given controls to it.
BorderLayout	destroyBegin() Destroys the begin in the Begin-aggregation.
BorderLayout	destroyBottom() Destroys the bottom in the Bottom-aggregation.
BorderLayout	destroyCenter() Destroys the center in the Center-aggregation.
void	destroyContent(String areaId) Destroys the content of the specified area.
BorderLayout	destroyEnd() Destroys the end in the End-aggregation.
BorderLayout	destroyTop() Destroys the top in the Top-aggregation.
com.sap.ui.core.client.Element	getAreaById(String areaId) Returns the object of the specified area.
Object	getAreaData(String areaId) Returns a JSON like object that contains all properties values of the requested area.
com.sap.ui.core.client.Element	getBegin() Getter for aggregation begin Represents the begin area
com.sap.ui.core.client.Element	getBottom() Getter for aggregation bottom Represents the bottom area
com.sap.ui.core.client.Element	getCenter() Getter for aggregation center Represents the center area
Object	getContent(String areaId) Returns all controls inside the specified area inside an array.
com.sap.ui.core.client.Element	getEnd() Getter for aggregation end Represents the end area
String	getHeight() Getter for property height Defines the height of the BorderLayout
com.sap.ui.core.client.Element	getTop() Getter for aggregation top Represents the top area
String	getWidth() Getter for property width Defines the width of the BorderLayout
int	indexOfContent(String areaId, com.sap.ui.core.client.Control content) Determines the index of a given content control.
void	insertContent(String areaId, int index, com.sap.ui.core.client.Control control) Inserts controls to an area at a given index.
boolean	isRtl() Getter for property rtl RTL will rotate the begin and end areas.
void	removeAllContent(String areaId) Removes all content from an area.
void	removeContent(String areaId, int index) Removes the content with the given index from an area.
void	setAreaData(String areaId, Object data) Set the properties of the specified area with the given values.
BorderLayout	setBegin(com.sap.ui.core.client.Element begin) Setter for the aggregated begin.
BorderLayout	setBottom(com.sap.ui.core.client.Element bottom) Setter for the aggregated bottom.
BorderLayout	setCenter(com.sap.ui.core.client.Element center) Setter for the aggregated center.
BorderLayout	setEnd(com.sap.ui.core.client.Element end) Setter for the aggregated end.
BorderLayout	setHeight(String value) Setter for property height Default value is: 100%
BorderLayout	setRtl(boolean value) Setter for property rtl Default value is: false
BorderLayout	setTop(com.sap.ui.core.client.Element top) Setter for the aggregated top.
BorderLayout	setWidth(String value) Setter for property width Default value is: 100%

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

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

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

BorderLayout

protected BorderLayout()

constructs the class BorderLayout
hidden due to JavaScriptObject restriction

Method Detail

create

public static BorderLayout create()

creates a new instance of the class BorderLayout

create

public static BorderLayout create(String idOrConfig)

creates a new instance of the class BorderLayout

Parameters:

id - id of the BorderLayout or configuration JSON string

create

public static BorderLayout create(String id,
                                  String config)

creates a new instance of the class BorderLayout

Parameters:

id - id of the BorderLayout

config - configuration JSON string

isRtl

public final boolean isRtl()

Getter for property rtl RTL will rotate the begin and end areas.

Returns:

the value of property rtl

setRtl

public final BorderLayout setRtl(boolean value)

Setter for property rtl
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width Defines the width of the BorderLayout

Returns:

the value of property width

setWidth

public final BorderLayout setWidth(String value)

Setter for property width
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

getHeight

public final String getHeight()

Getter for property height Defines the height of the BorderLayout

Returns:

the value of property height

setHeight

public final BorderLayout setHeight(String value)

Setter for property height
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

getTop

public final com.sap.ui.core.client.Element getTop()

Getter for aggregation top Represents the top area

Returns:

com.sap.ui.core.client.Element

setTop

public final BorderLayout setTop(com.sap.ui.core.client.Element top)

Setter for the aggregated top.

Parameters:

otop - {com.sap.ui.core.client.Element}

Returns:

this to allow method chaining

destroyTop

public final BorderLayout destroyTop()

Destroys the top in the Top-aggregation.

Returns:

this to allow method chaining

getBegin

public final com.sap.ui.core.client.Element getBegin()

Getter for aggregation begin Represents the begin area

Returns:

com.sap.ui.core.client.Element

setBegin

public final BorderLayout setBegin(com.sap.ui.core.client.Element begin)

Setter for the aggregated begin.

Parameters:

obegin - {com.sap.ui.core.client.Element}

Returns:

this to allow method chaining

destroyBegin

public final BorderLayout destroyBegin()

Destroys the begin in the Begin-aggregation.

Returns:

this to allow method chaining

getCenter

public final com.sap.ui.core.client.Element getCenter()

Getter for aggregation center Represents the center area

Returns:

com.sap.ui.core.client.Element

setCenter

public final BorderLayout setCenter(com.sap.ui.core.client.Element center)

Setter for the aggregated center.

Parameters:

ocenter - {com.sap.ui.core.client.Element}

Returns:

this to allow method chaining

destroyCenter

public final BorderLayout destroyCenter()

Destroys the center in the Center-aggregation.

Returns:

this to allow method chaining

getEnd

public final com.sap.ui.core.client.Element getEnd()

Getter for aggregation end Represents the end area

Returns:

com.sap.ui.core.client.Element

setEnd

public final BorderLayout setEnd(com.sap.ui.core.client.Element end)

Setter for the aggregated end.

Parameters:

oend - {com.sap.ui.core.client.Element}

Returns:

this to allow method chaining

destroyEnd

public final BorderLayout destroyEnd()

Destroys the end in the End-aggregation.

Returns:

this to allow method chaining

getBottom

public final com.sap.ui.core.client.Element getBottom()

Getter for aggregation bottom Represents the bottom area

Returns:

com.sap.ui.core.client.Element

setBottom

public final BorderLayout setBottom(com.sap.ui.core.client.Element bottom)

Setter for the aggregated bottom.

Parameters:

obottom - {com.sap.ui.core.client.Element}

Returns:

this to allow method chaining

destroyBottom

public final BorderLayout destroyBottom()

Destroys the bottom in the Bottom-aggregation.

Returns:

this to allow method chaining

createArea

public final com.sap.ui.core.client.Element createArea(String areaId,
                                                       com.sap.ui.core.client.Control controls)

Creates the specified area and adds the given controls to it. Returns the created area.

Parameters:

areaId - Specifies which area will be created. If the area has already been created, nothing is done.

controls - n Controls can be submitted to be added to the new created area. Each control is submitted as one argument.

setAreaData

public final void setAreaData(String areaId,
                              Object data)

Set the properties of the specified area with the given values.

Parameters:

areaId - Specifies the area whose properties will be set.

data - JSON-like object that contains the values to be set.

addContent

public final void addContent(String areaId,
                             com.sap.ui.core.client.Control controls)

Adds controls to the specified area.

Parameters:

areaId - Specifies the area where controls will be added.

controls - n Controls can be submitted to be added. Each control is submitted as one argument.

insertContent

public final void insertContent(String areaId,
                                int index,
                                com.sap.ui.core.client.Control control)

Inserts controls to an area at a given index.

Parameters:

areaId - Specifies the area where controls will be inserted.

index - Specifies the index where controls will be added. For a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position.

control - n Controls can be submitted to be added. Each control is submitted as one argument.

removeContent

public final void removeContent(String areaId,
                                int index)

Removes the content with the given index from an area.

Parameters:

areaId - Specifies the area whose content will be removed.

index - Specifies the index of the control that will be removed.

removeAllContent

public final void removeAllContent(String areaId)

Removes all content from an area.

Parameters:

areaId - Specifies the area whose content will be removed.

getContent

public final Object getContent(String areaId)

Returns all controls inside the specified area inside an array.

Parameters:

areaId - Specifies the area whose content controls will be returned.

indexOfContent

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

Determines the index of a given content control.

Parameters:

areaId - Specifies the area that will be searched.

content - Specifies the control whose index will be searched.

destroyContent

public final void destroyContent(String areaId)

Destroys the content of the specified area.

Parameters:

areaId - Specifies the area whose content will be destroyed.

getAreaData

public final Object getAreaData(String areaId)

Returns a JSON like object that contains all properties values of the requested area.

Parameters:

areaId - Specifies the area whose data will be returned.

getAreaById

public final com.sap.ui.core.client.Element getAreaById(String areaId)

Returns the object of the specified area. If the area does not exist, the area will be created and returned.

Parameters:

areaId - Specifies the area whose object will be returned.