com.sap.ui.commons.client
Class AccordionWidget

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

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 AccordionWidget
extends com.sap.ui.core.client.ControlWidget

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

Contains N sections which act as containers for any library control.

• Properties
  • width : String
    When the width specified is smaller than a section content, a horizontal scrollbar is provided.
  • openedSectionsId : String
    IDs of the opened sections by default and on first rendering.
• Aggregations
  • sections : com.sap.ui.commons.client.AccordionSection
    Empty container used to display any library controls.
• Associations
• Events
  • sectionOpen Triggered when user opens a section.
  • sectionClose Triggered when user closes a section.
  • sectionsReorder Triggered when user changes the position of a section.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: )

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

	AccordionWidget() constructs the class AccordionWidget
protected	AccordionWidget(Accordion control) constructs the class AccordionWidget
	AccordionWidget(String id) constructs the class AccordionWidget

Method Summary

void	addSection(AccordionSection section) Appends some section to the sections-aggregation.
void	attachSectionCloseEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Triggered when user closes a section.
void	attachSectionOpenEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Triggered when user opens a section.
void	attachSectionsReorderEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Triggered when user changes the position of a section.
void	closeSection(String sectionId) Closes a given section and opens the default section.
void	destroySections() Destroys all the sections in the Sections-aggregation.
void	detachSectionCloseEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Triggered when user closes a section.
void	detachSectionOpenEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Triggered when user opens a section.
void	detachSectionsReorderEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Triggered when user changes the position of a section.
Accordion	getControl() returns the reference to the Phoenix Control
String	getOpenedSectionsId() Getter for property openedSectionsId IDs of the opened sections by default and on first rendering.
com.sap.ui.core.client.js.JsArray<AccordionSection>	getSections() Getter for aggregation sections Empty container used to display any library controls.
String	getWidth() Getter for property width When the width specified is smaller than a section content, a horizontal scrollbar is provided.
int	indexOfSection(AccordionSection section) Checks for the provided com.sap.ui.commons.client.AccordionSection in the sections-aggregation and returns its index if found or -1 otherwise.
void	insertSection(AccordionSection section, int index) Inserts some section into the aggregation named sections.
void	openSection(String sectionId) Opens a given section.
void	removeAllSections() Removes all the items in the sections-aggregation.
void	removeSection(int index) Removes the section at position index in the sections-aggregation named.
void	setOpenedSectionsId(String value) Setter for property openedSectionsId
void	setWidth(String value) Setter for property width Default value is: 200px

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, setHeight, 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

AccordionWidget

public AccordionWidget()

constructs the class AccordionWidget

AccordionWidget

public AccordionWidget(String id)

constructs the class AccordionWidget

Parameters:

id - id of the AccordionWidget

AccordionWidget

protected AccordionWidget(Accordion control)

constructs the class AccordionWidget

Parameters:

control - reference to an existing Accordion

Method Detail

getControl

public Accordion 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 When the width specified is smaller than a section content, a horizontal scrollbar is provided.

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 200px

Overrides:

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

Parameters:

value - String

getOpenedSectionsId

public String getOpenedSectionsId()

Getter for property openedSectionsId IDs of the opened sections by default and on first rendering.

Returns:

the value of property openedSectionsId

setOpenedSectionsId

public void setOpenedSectionsId(String value)

Setter for property openedSectionsId

Parameters:

value - String

getSections

public com.sap.ui.core.client.js.JsArray<AccordionSection> getSections()

Getter for aggregation sections Empty container used to display any library controls.

Returns:

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

insertSection

public void insertSection(AccordionSection section,
                          int index)

Inserts some section into the aggregation named sections.

Parameters:

section - the section to insert

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

addSection

public void addSection(AccordionSection section)

Appends some section to the sections-aggregation.

Parameters:

section - com.sap.ui.commons.client.AccordionSection the section to add

removeSection

public void removeSection(int index)

Removes the section at position index in the sections-aggregation named.

Parameters:

index - int the position of the section to remove.

removeAllSections

public void removeAllSections()

Removes all the items in the sections-aggregation.

indexOfSection

public int indexOfSection(AccordionSection section)

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

Parameters:

section - the section whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroySections

public void destroySections()

Destroys all the sections in the Sections-aggregation.

attachSectionOpenEvent

public void attachSectionOpenEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Triggered when user opens a section.

Event Parameters:

{sap.ui.core/string} openSectionId ID of the section opened.

{string[]} closeSectionIds Index of the sections to close. It can be initial if no section were previously open.

Parameters:

listener - reference to the EventListener

detachSectionOpenEvent

public void detachSectionOpenEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Triggered when user opens a section.

Parameters:

listener - reference to the EventListener

attachSectionCloseEvent

public void attachSectionCloseEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Triggered when user closes a section.

Event Parameters:

{sap.ui.core/string} closeSectionId ID of the section closed.

Parameters:

listener - reference to the EventListener

detachSectionCloseEvent

public void detachSectionCloseEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Triggered when user closes a section.

Parameters:

listener - reference to the EventListener

attachSectionsReorderEvent

public void attachSectionsReorderEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Triggered when user changes the position of a section.

Event Parameters:

{sap.ui.core/string} movedSectionId ID of the moved section.

{sap.ui.core/int} newIndex New index of the moved section.

Parameters:

listener - reference to the EventListener

detachSectionsReorderEvent

public void detachSectionsReorderEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Triggered when user changes the position of a section.

Parameters:

listener - reference to the EventListener

openSection

public void openSection(String sectionId)

Opens a given section.

Parameters:

sectionId - Section to open.

closeSection

public void closeSection(String sectionId)

Closes a given section and opens the default section.

Parameters:

sectionId - Section to close.