com.sap.ui.commons.client
Class PanelWidget

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

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

Direct Known Subclasses:

TabWidget

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

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 AG)

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

	PanelWidget() constructs the class PanelWidget
protected	PanelWidget(Panel control) constructs the class PanelWidget
	PanelWidget(String id) constructs the class PanelWidget

Method Summary

void	addButton(Button button) Appends some button to the buttons-aggregation.
void	addContent(com.sap.ui.core.client.Control content) Appends some content to the content-aggregation.
void	destroyButtons() Destroys all the buttons in the Buttons-aggregation.
void	destroyContent() Destroys all the content in the Content-aggregation.
void	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.
Panel	getControl() returns the reference to the Phoenix Control
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.
void	insertButton(Button button, int index) Inserts some button into the aggregation named buttons.
void	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.
void	removeAllButtons() Removes all the items in the buttons-aggregation.
void	removeAllContent() Removes all the items in the content-aggregation.
void	removeButton(int index) Removes the button at position index in the buttons-aggregation named.
void	removeContent(int index) Removes the content at position index in the content-aggregation named.
void	setApplyContentPadding(boolean value) Setter for property applyContentPadding Default value is: true
void	setAreaDesign(AreaDesign value) Setter for property areaDesign Default value is: Fill
void	setBorderDesign(BorderDesign value) Setter for property borderDesign Default value is: Box
void	setCollapsed(boolean value) Setter for property collapsed Default value is: false
void	setDimensions(String width, String height) Sets panel dimensions width and height.
void	setEnabled(boolean value) Setter for property enabled Default value is: true
void	setHeight(String value) Setter for property height
void	setScrollLeft(int value) Setter for property scrollLeft Default value is: 0
void	setScrollTop(int value) Setter for property scrollTop Default value is: 0
void	setShowCollapseIcon(boolean value) Setter for property showCollapseIcon Default value is: true
void	setText(String text) Defines title text (quick version).
void	setTitle(Title title) Setter for the aggregated title.
void	setVisible(boolean value) Setter for property visible Default value is: true
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, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

PanelWidget

public PanelWidget()

constructs the class PanelWidget

PanelWidget

public PanelWidget(String id)

constructs the class PanelWidget

Parameters:

id - id of the PanelWidget

PanelWidget

protected PanelWidget(Panel control)

constructs the class PanelWidget

Parameters:

control - reference to an existing Panel

Method Detail

getControl

public Panel getControl()

returns the reference to the Phoenix Control

Overrides:

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

Returns:

reference to the Phoenix Control

getWidth

public String getWidth()

Getter for property width The width of the Panel.

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

Returns:

the value of property height

setHeight

public void setHeight(String value)

Setter for property height

Overrides:

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

Parameters:

value - String

isEnabled

public boolean isEnabled()

Getter for property enabled The enabled state of the Panel.

Returns:

the value of property enabled

setEnabled

public void setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

isVisible

public boolean isVisible()

Getter for property visible Invisible panels are not rendered.

Overrides:

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

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

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

Parameters:

value - boolean

getScrollLeft

public 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 void setScrollLeft(int value)

Setter for property scrollLeft
Default value is: 0

Parameters:

value - int

getScrollTop

public 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 void setScrollTop(int value)

Setter for property scrollTop
Default value is: 0

Parameters:

value - int

isApplyContentPadding

public boolean isApplyContentPadding()

Getter for property applyContentPadding Padding is theme-dependent.

Returns:

the value of property applyContentPadding

setApplyContentPadding

public void setApplyContentPadding(boolean value)

Setter for property applyContentPadding
Default value is: true

Parameters:

value - boolean

isCollapsed

public 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 void setCollapsed(boolean value)

Setter for property collapsed
Default value is: false

Parameters:

value - boolean

getAreaDesign

public 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 void setAreaDesign(AreaDesign value)

Setter for property areaDesign
Default value is: Fill

Parameters:

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

getBorderDesign

public 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 void setBorderDesign(BorderDesign value)

Setter for property borderDesign
Default value is: Box

Parameters:

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

isShowCollapseIcon

public 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 void setShowCollapseIcon(boolean value)

Setter for property showCollapseIcon
Default value is: true

Parameters:

value - boolean

getContent

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

addContent

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

Appends some content to the content-aggregation.

Parameters:

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

removeContent

public void removeContent(int index)

Removes the content at position index in the content-aggregation named.

Parameters:

index - int the position of the content to remove.

removeAllContent

public void removeAllContent()

Removes all the items in the content-aggregation.

indexOfContent

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

Destroys all the content in the Content-aggregation.

getTitle_

public 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 void setTitle(Title title)

Setter for the aggregated title.

Parameters:

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

destroyTitle

public void destroyTitle()

Destroys the title in the Title-aggregation.

getButtons

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

addButton

public void addButton(Button button)

Appends some button to the buttons-aggregation.

Parameters:

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

removeButton

public void removeButton(int index)

Removes the button at position index in the buttons-aggregation named.

Parameters:

index - int the position of the button to remove.

removeAllButtons

public void removeAllButtons()

Removes all the items in the buttons-aggregation.

indexOfButton

public 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 void destroyButtons()

Destroys all the buttons in the Buttons-aggregation.

setDimensions

public 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 void setText(String text)

Defines title text (quick version).

Parameters:

text - Title text to be displayed.