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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.layout.BorderLayoutWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class BorderLayoutWidget
extends com.sap.ui.core.client.ControlWidget

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: Maximilian Naehrlich)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	BorderLayoutWidget() constructs the class BorderLayoutWidget
protected	BorderLayoutWidget(BorderLayout control) constructs the class BorderLayoutWidget
	BorderLayoutWidget(String id) constructs the class BorderLayoutWidget

Method Summary

void	addContent(String areaId, com.sap.ui.core.client.Control controls) Adds controls to the specified area.
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.
void	destroyBegin() Destroys the begin in the Begin-aggregation.
void	destroyBottom() Destroys the bottom in the Bottom-aggregation.
void	destroyCenter() Destroys the center in the Center-aggregation.
void	destroyContent(String areaId) Destroys the content of the specified area.
void	destroyEnd() Destroys the end in the End-aggregation.
void	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.
BorderLayout	getControl() returns the reference to the Phoenix Control
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.
void	setBegin(com.sap.ui.core.client.Element begin) Setter for the aggregated begin.
void	setBottom(com.sap.ui.core.client.Element bottom) Setter for the aggregated bottom.
void	setCenter(com.sap.ui.core.client.Element center) Setter for the aggregated center.
void	setEnd(com.sap.ui.core.client.Element end) Setter for the aggregated end.
void	setHeight(String value) Setter for property height Default value is: 100%
void	setRtl(boolean value) Setter for property rtl Default value is: false
void	setTop(com.sap.ui.core.client.Element top) Setter for the aggregated top.
void	setWidth(String value) Setter for property width Default value is: 100%

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BorderLayoutWidget

public BorderLayoutWidget()

constructs the class BorderLayoutWidget

BorderLayoutWidget

public BorderLayoutWidget(String id)

constructs the class BorderLayoutWidget

Parameters:

id - id of the BorderLayoutWidget

BorderLayoutWidget

protected BorderLayoutWidget(BorderLayout control)

constructs the class BorderLayoutWidget

Parameters:

control - reference to an existing BorderLayout

Method Detail

getControl

public BorderLayout getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

isRtl

public boolean isRtl()

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

Returns:

the value of property rtl

setRtl

public void setRtl(boolean value)

Setter for property rtl
Default value is: false

Parameters:

value - boolean

getWidth

public String getWidth()

Getter for property width Defines the width of the BorderLayout

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 100%

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getHeight

public String getHeight()

Getter for property height Defines the height of the BorderLayout

Returns:

the value of property height

setHeight

public void setHeight(String value)

Setter for property height
Default value is: 100%

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getTop

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

Getter for aggregation top Represents the top area

Returns:

com.sap.ui.core.client.Element

setTop

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

Setter for the aggregated top.

Parameters:

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

destroyTop

public void destroyTop()

Destroys the top in the Top-aggregation.

getBegin

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

Getter for aggregation begin Represents the begin area

Returns:

com.sap.ui.core.client.Element

setBegin

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

Setter for the aggregated begin.

Parameters:

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

destroyBegin

public void destroyBegin()

Destroys the begin in the Begin-aggregation.

getCenter

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

Getter for aggregation center Represents the center area

Returns:

com.sap.ui.core.client.Element

setCenter

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

Setter for the aggregated center.

Parameters:

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

destroyCenter

public void destroyCenter()

Destroys the center in the Center-aggregation.

getEnd

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

Getter for aggregation end Represents the end area

Returns:

com.sap.ui.core.client.Element

setEnd

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

Setter for the aggregated end.

Parameters:

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

destroyEnd

public void destroyEnd()

Destroys the end in the End-aggregation.

getBottom

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

Getter for aggregation bottom Represents the bottom area

Returns:

com.sap.ui.core.client.Element

setBottom

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

Setter for the aggregated bottom.

Parameters:

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

destroyBottom

public void destroyBottom()

Destroys the bottom in the Bottom-aggregation.

createArea

public 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 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 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 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 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 void removeAllContent(String areaId)

Removes all content from an area.

Parameters:

areaId - Specifies the area whose content will be removed.

getContent

public 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 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 void destroyContent(String areaId)

Destroys the content of the specified area.

Parameters:

areaId - Specifies the area whose content will be destroyed.

getAreaData

public 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 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.