com.sap.ui.commons.client
Class Panel

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

Direct Known Subclasses:

Tab

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

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

A scrollable container for text and/or controls. The panel does not layout the contained controls.

• Properties
  • width : String
    The width of the Panel.
  • height : String
    When not set, the panel height is automatically adjusted to the content.
  • enabled : boolean
    The enabled state of the Panel.
  • visible : boolean
    Invisible panels are not rendered.
  • scrollLeft : int
    Specifies the scroll position from left to right. Value "0" means leftmost position.
  • scrollTop : int
    Specifies the scroll position from top to bottom. Value "0" means topmost position.
  • applyContentPadding : boolean
    Padding is theme-dependent.
  • collapsed : boolean
    A collapsed panel consumes minimal space. When initially collapsed, its contents are not rendered.
  • areaDesign : com.sap.ui.commons.client.enums.AreaDesign
    Defines the background color. Depending on the current theme, this setting may or may not have any effect.
  • borderDesign : com.sap.ui.commons.client.enums.BorderDesign
    The panel can have a box as frame. Depending on the current theme, this setting may or may not have any effect.
  • showCollapseIcon : boolean
    Determines whether the Panel should have an icon for collapsing/expanding.
• Aggregations
  • content : com.sap.ui.core.client.Control
    Aggregates the controls that are contained in the panel where the control layouting is browser-dependent. For a stable content layout, it is recommended to use a layout control as single direct child. When the panel dimensions are set, the child control may have width and height of 100%. when the dimensions are not set, the child defines the panel size.
  • title : com.sap.ui.commons.client.Title
    Aggregates the title element of the panel. For text titles only, you alternatively could use setText().
  • buttons : com.sap.ui.commons.client.Button
    The Buttons to be displayed in the Panel header
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.Panel)

Constructor Summary

protected

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

Method Summary

Panel	addButton(Button button) Appends a button to the aggregation buttons.
Panel	addContent(com.sap.ui.core.client.Control content) Appends a content to the aggregation content.
static Panel	create() creates a new instance of the class Panel
static Panel	create(String idOrConfig) creates a new instance of the class Panel
static Panel	create(String id, String config) creates a new instance of the class Panel
Panel	destroyButtons() Destroys all the buttons in the Buttons-aggregation.
Panel	destroyContent() Destroys all the content in the Content-aggregation.
Panel	destroyTitle() Destroys the title in the Title-aggregation.
AreaDesign	getAreaDesign() Getter for property areaDesign Defines the background color.
BorderDesign	getBorderDesign() Getter for property borderDesign The panel can have a box as frame.
com.sap.ui.core.client.js.JsArray<Button>	getButtons() Getter for aggregation buttons The Buttons to be displayed in the Panel header
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getContent() Getter for aggregation content Aggregates the controls that are contained in the panel where the control layouting is browser-dependent.
String	getHeight() Getter for property height When not set, the panel height is automatically adjusted to the content.
int	getScrollLeft() Getter for property scrollLeft Specifies the scroll position from left to right.
int	getScrollTop() Getter for property scrollTop Specifies the scroll position from top to bottom.
Title	getTitle() Getter for aggregation title Aggregates the title element of the panel.
String	getWidth() Getter for property width The width of the Panel.
int	indexOfButton(Button button) Checks for the provided com.sap.ui.commons.client.Button in the buttons-aggregation and returns its index if found or -1 otherwise.
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.
Panel	insertButton(Button button, int index) Inserts some button into the aggregation named buttons.
Panel	insertContent(com.sap.ui.core.client.Control content, int index) Inserts some content into the aggregation named content.
boolean	isApplyContentPadding() Getter for property applyContentPadding Padding is theme-dependent.
boolean	isCollapsed() Getter for property collapsed A collapsed panel consumes minimal space.
boolean	isEnabled() Getter for property enabled The enabled state of the Panel.
boolean	isShowCollapseIcon() Getter for property showCollapseIcon Determines whether the Panel should have an icon for collapsing/expanding.
boolean	isVisible() Getter for property visible Invisible panels are not rendered.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<Button>>	removeAllButtons() Removes all the items in the buttons-aggregation.
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<Button>	removeButton(int index) Removes a button from the aggregation named buttons.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeContent(int index) Removes a content from the aggregation named content.
Panel	setApplyContentPadding(boolean value) Setter for property applyContentPadding Default value is: true
Panel	setAreaDesign(AreaDesign value) Setter for property areaDesign Default value is: Fill
Panel	setBorderDesign(BorderDesign value) Setter for property borderDesign Default value is: Box
Panel	setCollapsed(boolean value) Setter for property collapsed Default value is: false
void	setDimensions(String width, String height) Sets panel dimensions width and height.
Panel	setEnabled(boolean value) Setter for property enabled Default value is: true
Panel	setHeight(String value) Setter for property height
Panel	setScrollLeft(int value) Setter for property scrollLeft Default value is: 0
Panel	setScrollTop(int value) Setter for property scrollTop Default value is: 0
Panel	setShowCollapseIcon(boolean value) Setter for property showCollapseIcon Default value is: true
void	setText(String text) Defines title text (quick version).
Panel	setTitle(Title title) Setter for the aggregated title.
Panel	setVisible(boolean value) Setter for property visible Default value is: true
Panel	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

Panel

protected Panel()

constructs the class Panel
hidden due to JavaScriptObject restriction

Method Detail

create

public static Panel create()

creates a new instance of the class Panel

create

public static Panel create(String idOrConfig)

creates a new instance of the class Panel

Parameters:

id - id of the Panel or configuration JSON string

create

public static Panel create(String id,
                           String config)

creates a new instance of the class Panel

Parameters:

id - id of the Panel

config - configuration JSON string

getWidth

public final String getWidth()

Getter for property width The width of the Panel.

Returns:

the value of property width

setWidth

public final Panel 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 When not set, the panel height is automatically adjusted to the content.

Returns:

the value of property height

setHeight

public final Panel setHeight(String value)

Setter for property height

Parameters:

value - String

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled The enabled state of the Panel.

Returns:

the value of property enabled

setEnabled

public final Panel setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible panels are not rendered.

Returns:

the value of property visible

setVisible

public final Panel setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getScrollLeft

public final int getScrollLeft()

Getter for property scrollLeft Specifies the scroll position from left to right. Value "0" means leftmost position.

Returns:

the value of property scrollLeft

setScrollLeft

public final Panel setScrollLeft(int value)

Setter for property scrollLeft
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

getScrollTop

public final int getScrollTop()

Getter for property scrollTop Specifies the scroll position from top to bottom. Value "0" means topmost position.

Returns:

the value of property scrollTop

setScrollTop

public final Panel setScrollTop(int value)

Setter for property scrollTop
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

isApplyContentPadding

public final boolean isApplyContentPadding()

Getter for property applyContentPadding Padding is theme-dependent.

Returns:

the value of property applyContentPadding

setApplyContentPadding

public final Panel setApplyContentPadding(boolean value)

Setter for property applyContentPadding
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isCollapsed

public final boolean isCollapsed()

Getter for property collapsed A collapsed panel consumes minimal space. When initially collapsed, its contents are not rendered.

Returns:

the value of property collapsed

setCollapsed

public final Panel setCollapsed(boolean value)

Setter for property collapsed
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getAreaDesign

public final AreaDesign getAreaDesign()

Getter for property areaDesign Defines the background color. Depending on the current theme, this setting may or may not have any effect.

Returns:

the value of property areaDesign

setAreaDesign

public final Panel setAreaDesign(AreaDesign value)

Setter for property areaDesign
Default value is: Fill

Parameters:

value - com.sap.ui.commons.client.enums.AreaDesign

Returns:

this to allow method chaining

getBorderDesign

public final BorderDesign getBorderDesign()

Getter for property borderDesign The panel can have a box as frame. Depending on the current theme, this setting may or may not have any effect.

Returns:

the value of property borderDesign

setBorderDesign

public final Panel setBorderDesign(BorderDesign value)

Setter for property borderDesign
Default value is: Box

Parameters:

value - com.sap.ui.commons.client.enums.BorderDesign

Returns:

this to allow method chaining

isShowCollapseIcon

public final boolean isShowCollapseIcon()

Getter for property showCollapseIcon Determines whether the Panel should have an icon for collapsing/expanding.

Returns:

the value of property showCollapseIcon

setShowCollapseIcon

public final Panel setShowCollapseIcon(boolean value)

Setter for property showCollapseIcon
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 Aggregates the controls that are contained in the panel where the control layouting is browser-dependent. For a stable content layout, it is recommended to use a layout control as single direct child. When the panel dimensions are set, the child control may have width and height of 100%. when the dimensions are not set, the child defines the panel size.

Returns:

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

insertContent

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

Destroys all the content in the Content-aggregation.

Returns:

this to allow method chaining

getTitle

public final Title getTitle()

Getter for aggregation title Aggregates the title element of the panel. For text titles only, you alternatively could use setText().

Returns:

com.sap.ui.commons.client.Title

setTitle

public final Panel setTitle(Title title)

Setter for the aggregated title.

Parameters:

otitle - {com.sap.ui.commons.client.Title}

Returns:

this to allow method chaining

destroyTitle

public final Panel destroyTitle()

Destroys the title in the Title-aggregation.

Returns:

this to allow method chaining

getButtons

public final com.sap.ui.core.client.js.JsArray<Button> getButtons()

Getter for aggregation buttons The Buttons to be displayed in the Panel header

Returns:

com.sap.ui.commons.client.Button[]

insertButton

public final Panel insertButton(Button button,
                                int index)

Inserts some button into the aggregation named buttons.

Parameters:

button - the button to insert

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

Returns:

this to allow method chaining

addButton

public final Panel addButton(Button button)

Appends a button to the aggregation buttons.

Parameters:

button - com.sap.ui.commons.client.Button the button to add

Returns:

this to allow method chaining

removeButton

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

Removes a button from the aggregation named buttons.

Parameters:

index - int the position of the button to remove.

Returns:

reference to this instance

removeAllButtons

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<Button>> removeAllButtons()

Removes all the items in the buttons-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfButton

public final int indexOfButton(Button button)

Checks for the provided com.sap.ui.commons.client.Button in the buttons-aggregation and returns its index if found or -1 otherwise.

Parameters:

button - the button whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyButtons

public final Panel destroyButtons()

Destroys all the buttons in the Buttons-aggregation.

Returns:

this to allow method chaining

setDimensions

public final void setDimensions(String width,
                                String height)

Sets panel dimensions width and height.

Parameters:

width - Panel width as CSS size.

height - Panel height as CSS size.

setText

public final void setText(String text)

Defines title text (quick version).

Parameters:

text - Title text to be displayed.