com.sap.ui.commons.client
Class AccordionSection

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

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

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

Represents a UI panel that is a simple container for controls. The panel does not layout the contained controls.

• Properties
  • maxHeight : String
    When the section content exceeds the maxHeight, a vertical scrollbar appears.
  • enabled : boolean
    Requirement is that the used theme supports the control.
  • collapsed : boolean
    A collapsed panel consumes minimal space. When initially collapsed, its contents are not rendered. The recommendation is to set the panel width if the control shall be collapsed.
  • title : String
    Section header text.
• Aggregations
  • controls : com.sap.ui.core.client.Control
    Aggregates the controls that are contained in the panel. Control layouting is browser-dependent. For a stable content layout, use a layout control as direct single child. When the panel dimensions are set, the child control may have width and height of 100%; when the panel dimensions are not set, the child defines the panel size.
  • content : com.sap.ui.core.client.Control
    Aggregates the controls that are contained in the panel. Control layouting is browser-dependent. For a stable content layout, use a layout control as direct single child. When the panel dimensions are set, the child control may have width and height of 100%; when the panel dimensions are not set, the child defines the panel size.
• Associations
• Events
  • scroll Event is fired when the user scrolls the panel.

For further parameters see {@link com.sap.ui.core.client.Element

Version:

0.16.0

Author:

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

Constructor Summary

protected

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

Method Summary

AccordionSection	addContent(com.sap.ui.core.client.Control content) Appends a content to the aggregation content.
AccordionSection	addControl(com.sap.ui.core.client.Control control) Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
AccordionSection	attachScrollEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user scrolls the panel.
static AccordionSection	create() creates a new instance of the class AccordionSection
static AccordionSection	create(java.lang.String idOrConfig) creates a new instance of the class AccordionSection
static AccordionSection	create(java.lang.String id, java.lang.String config) creates a new instance of the class AccordionSection
AccordionSection	destroyContent() Destroys all the content in the Content-aggregation.
AccordionSection	destroyControls() Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
AccordionSection	detachScrollEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user scrolls the panel.
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.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getControls() Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
java.lang.String	getMaxHeight() Getter for property maxHeight When the section content exceeds the maxHeight, a vertical scrollbar appears.
java.lang.String	getTitle() Getter for property title Section header text.
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.
int	indexOfControl(com.sap.ui.core.client.Control control) Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
AccordionSection	insertContent(com.sap.ui.core.client.Control content, int index) Inserts some content into the aggregation named content.
AccordionSection	insertControl(com.sap.ui.core.client.Control control, int index) Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
boolean	isCollapsed() Getter for property collapsed A collapsed panel consumes minimal space.
boolean	isEnabled() Getter for property enabled Requirement is that the used theme supports the control.
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.js.JsArray<com.sap.ui.core.client.Control>>	removeAllControls() Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeContent(int index) Removes a content from the aggregation named content.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeControl(int index) Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.
AccordionSection	setCollapsed(boolean value) Setter for property collapsed Default value is: false
AccordionSection	setEnabled(boolean value) Setter for property enabled Default value is: true
AccordionSection	setMaxHeight(java.lang.String value) Setter for property maxHeight
AccordionSection	setTitle(java.lang.String value) Setter for property title

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

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachEvent, bind, bindAggregation, bindProperty, bindProperty, destroy, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, 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

AccordionSection

protected AccordionSection()

constructs the class AccordionSection
hidden due to JavaScriptObject restriction

Method Detail

create

public static AccordionSection create()

creates a new instance of the class AccordionSection

create

public static AccordionSection create(java.lang.String idOrConfig)

creates a new instance of the class AccordionSection

Parameters:

id - id of the AccordionSection or configuration JSON string

create

public static AccordionSection create(java.lang.String id,
                                      java.lang.String config)

creates a new instance of the class AccordionSection

Parameters:

id - id of the AccordionSection

config - configuration JSON string

getMaxHeight

public final java.lang.String getMaxHeight()

Getter for property maxHeight When the section content exceeds the maxHeight, a vertical scrollbar appears.

Returns:

the value of property maxHeight

setMaxHeight

public final AccordionSection setMaxHeight(java.lang.String value)

Setter for property maxHeight

Parameters:

value - String

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled Requirement is that the used theme supports the control.

Returns:

the value of property enabled

setEnabled

public final AccordionSection setEnabled(boolean value)

Setter for property enabled
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. The recommendation is to set the panel width if the control shall be collapsed.

Returns:

the value of property collapsed

setCollapsed

public final AccordionSection setCollapsed(boolean value)

Setter for property collapsed
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getTitle

public final java.lang.String getTitle()

Getter for property title Section header text.

Returns:

the value of property title

setTitle

public final AccordionSection setTitle(java.lang.String value)

Setter for property title

Parameters:

value - String

Returns:

this to allow method chaining

getControls

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> getControls()

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Getter for aggregation controls Aggregates the controls that are contained in the panel. Control layouting is browser-dependent. For a stable content layout, use a layout control as direct single child. When the panel dimensions are set, the child control may have width and height of 100%; when the panel dimensions are not set, the child defines the panel size.

Returns:

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

insertControl

public final AccordionSection insertControl(com.sap.ui.core.client.Control control,
                                            int index)

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Inserts some control into the aggregation named controls.

Parameters:

control - the control to insert

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

Returns:

this to allow method chaining

addControl

public final AccordionSection addControl(com.sap.ui.core.client.Control control)

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Appends a control to the aggregation controls.

Parameters:

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

Returns:

this to allow method chaining

removeControl

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

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Removes a control from the aggregation named controls.

Parameters:

index - int the position of the control to remove.

Returns:

reference to this instance

removeAllControls

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>> removeAllControls()

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Removes all the items in the controls-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfControl

public final int indexOfControl(com.sap.ui.core.client.Control control)

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Checks for the provided com.sap.ui.core.client.Control in the controls-aggregation and returns its index if found or -1 otherwise.

Parameters:

control - the control whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyControls

public final AccordionSection destroyControls()

Deprecated. Since version 0.12.0. Replaced by the new aggregation 'content'. Please use the new aggregation instead. The support of the aggregation 'controls' will be removed in one of the next versions.

Destroys all the controls in the Controls-aggregation.

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. Control layouting is browser-dependent. For a stable content layout, use a layout control as direct single child. When the panel dimensions are set, the child control may have width and height of 100%; when the panel dimensions are not set, the child defines the panel size.

Returns:

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

insertContent

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

Destroys all the content in the Content-aggregation.

Returns:

this to allow method chaining

attachScrollEvent

public final AccordionSection attachScrollEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when the user scrolls the panel.

Event Parameters:

{int} left Horizontal scroll position.

{int} top Vertical scroll position.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachScrollEvent

public final AccordionSection detachScrollEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when the user scrolls the panel.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining