com.haulmont.cuba.web.gui.components

Class WebAccordion

java.lang.Object

com.haulmont.bali.events.EventRouter

com.haulmont.cuba.web.gui.components.WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>

com.haulmont.cuba.web.gui.components.WebAccordion

All Implemented Interfaces:

Accordion, Component, Component.BelongToFrame, Component.Container, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.UiPermissionAware, Component.Wrapper

public class WebAccordion
extends WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>
implements Accordion, Component.UiPermissionAware

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Accordion

Accordion.SelectedTabChangeEvent, Accordion.SelectedTabChangeListener, Accordion.TabChangeListener

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

ICON_STYLE, UNIT_SYMBOLS

Fields inherited from interface com.haulmont.cuba.gui.components.Accordion

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
WebAccordion()

Method Summary

Modifier and Type	Method and Description
void	add(Component component)
Accordion.Tab	addLazyTab(java.lang.String name, org.dom4j.Element descriptor, ComponentLoader loader) INTERNAL.
void	addListener(Accordion.TabChangeListener listener) Add a listener that will be notified when a selected tab is changed.
void	addSelectedTabChangeListener(Accordion.SelectedTabChangeListener listener) Add a listener that will be notified when a selected tab is changed.
Accordion.Tab	addTab(java.lang.String name, Component childComponent) Add a new tab to the component.
void	applyPermission(UiPermissionDescriptor permissionDescriptor) Change state of subcomponent according to the permissionValue.
Component	getComponent(java.lang.String id) Get component belonging to the whole components tree below this container.
java.util.Collection<Component>	getComponents() Get all components belonging to the whole components tree below this container
java.lang.String	getDescription()
Component	getOwnComponent(java.lang.String id) Get component directly owned by this container.
java.util.Collection<Component>	getOwnComponents() Get all components directly owned by this container
com.haulmont.cuba.web.gui.components.WebAccordion.Tab	getSelectedTab() Get selected tab.
Accordion.Tab	getTab(java.lang.String name) Get tab with the provided id.
Component	getTabComponent(java.lang.String name) Get a component that is a content of the tab.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
java.util.Collection<Accordion.Tab>	getTabs() Get all tabs.
boolean	isTabCaptionsAsHtml()
void	remove(Component component)
void	removeAll()
void	removeAllTabs() Remove all tabs.
void	removeListener(Accordion.TabChangeListener listener)
void	removeSelectedTabChangeListener(Accordion.SelectedTabChangeListener listener) Remove previously added SelectedTabChangeListener.
void	removeTab(java.lang.String name) Remove tab.
void	setDebugId(java.lang.String id) INTERNAL.
void	setDescription(java.lang.String description)
void	setFrame(Frame frame)
void	setSelectedTab(Accordion.Tab tab) Set selected tab.
void	setSelectedTab(java.lang.String name) Set selected tab.
void	setTabCaptionsAsHtml(boolean tabCaptionsAsHtml) Sets whether HTML is allowed in the tab captions.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComponentEnabledFlag, getComponentVisibleFlag, getComposition, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getWidth, getWidthUnits, getXmlDescriptor, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setEnabled, setHeight, setIcon, setId, setParent, setResponsive, setStyleName, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class com.haulmont.bali.events.EventRouter

addListener, addListener, fireEvent, hasListeners, removeListener, removeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.Accordion

getTab, setTab, setTab

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Container

getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

isFocusable, setFocusable

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Constructor Detail

WebAccordion

public WebAccordion()

Method Detail

add

public void add(Component component)

Specified by:

add in interface Component.Container

remove

public void remove(Component component)

Specified by:

remove in interface Component.Container

removeAll

public void removeAll()

Specified by:

removeAll in interface Component.Container

getOwnComponent

public Component getOwnComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component directly owned by this container.

Specified by:

getOwnComponent in interface Component.Container

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component belonging to the whole components tree below this container.

Specified by:

getComponent in interface Component.Container

Returns:

component or null if not found

getOwnComponents

public java.util.Collection<Component> getOwnComponents()

Description copied from interface: Component.Container

Get all components directly owned by this container

Specified by:

getOwnComponents in interface Component.Container

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: Component.Container

Get all components belonging to the whole components tree below this container

Specified by:

getComponents in interface Component.Container

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

Overrides:

getDescription in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

Overrides:

setDescription in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>

applyPermission

public void applyPermission(UiPermissionDescriptor permissionDescriptor)

Description copied from interface: Component.UiPermissionAware

Change state of subcomponent according to the permissionValue.

Specified by:

applyPermission in interface Component.UiPermissionAware

Parameters:

permissionDescriptor - descriptor which contains id of subcomponent and UI permission value which will be applied to this subcomponent or ids of subcomponent and its action and UI permission value which will be applied to subcomponent's action

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

removeTab

public void removeTab(java.lang.String name)

Description copied from interface: Accordion

Remove tab.

Specified by:

removeTab in interface Accordion

Parameters:

name - id of the tab to remove

removeAllTabs

public void removeAllTabs()

Description copied from interface: Accordion

Remove all tabs.

Specified by:

removeAllTabs in interface Accordion

addTab

public Accordion.Tab addTab(java.lang.String name,
                            Component childComponent)

Description copied from interface: Accordion

Add a new tab to the component.

Specified by:

addTab in interface Accordion

Parameters:

name - id of the new tab

childComponent - a component that will be the content of the new tab

Returns:

the new tab

setDebugId

public void setDebugId(java.lang.String id)

Description copied from interface: Component

INTERNAL. Managed by debug Id system.

Specified by:

setDebugId in interface Component

Overrides:

setDebugId in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>

addLazyTab

public Accordion.Tab addLazyTab(java.lang.String name,
                                org.dom4j.Element descriptor,
                                ComponentLoader loader)

Description copied from interface: Accordion

INTERNAL. Add a new lazy tab to the component.

Specified by:

addLazyTab in interface Accordion

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaAccordion>

getSelectedTab

public com.haulmont.cuba.web.gui.components.WebAccordion.Tab getSelectedTab()

Description copied from interface: Accordion

Get selected tab. May be null if the accordion does not contain tabs at all.

Specified by:

getSelectedTab in interface Accordion

setSelectedTab

public void setSelectedTab(Accordion.Tab tab)

Description copied from interface: Accordion

Set selected tab.

Specified by:

setSelectedTab in interface Accordion

Parameters:

tab - tab instance

setSelectedTab

public void setSelectedTab(java.lang.String name)

Description copied from interface: Accordion

Set selected tab.

Specified by:

setSelectedTab in interface Accordion

Parameters:

name - tab id

getTab

public Accordion.Tab getTab(java.lang.String name)

Description copied from interface: Accordion

Get tab with the provided id.

Specified by:

getTab in interface Accordion

Parameters:

name - tab id

Returns:

tab instance

getTabComponent

public Component getTabComponent(java.lang.String name)

Description copied from interface: Accordion

Get a component that is a content of the tab.

Specified by:

getTabComponent in interface Accordion

Parameters:

name - tab id

Returns:

tab content

getTabs

public java.util.Collection<Accordion.Tab> getTabs()

Description copied from interface: Accordion

Get all tabs.

Specified by:

getTabs in interface Accordion

isTabCaptionsAsHtml

public boolean isTabCaptionsAsHtml()

Specified by:

isTabCaptionsAsHtml in interface Accordion

Returns:

true if the tab captions are rendered as HTML, false if rendered as plain text

setTabCaptionsAsHtml

public void setTabCaptionsAsHtml(boolean tabCaptionsAsHtml)

Description copied from interface: Accordion

Sets whether HTML is allowed in the tab captions.

Specified by:

setTabCaptionsAsHtml in interface Accordion

Parameters:

tabCaptionsAsHtml - true if the tab captions are rendered as HTML, false if rendered as plain text

addListener

public void addListener(Accordion.TabChangeListener listener)

Description copied from interface: Accordion

Add a listener that will be notified when a selected tab is changed.

Specified by:

addListener in interface Accordion

removeListener

public void removeListener(Accordion.TabChangeListener listener)

Specified by:

removeListener in interface Accordion

addSelectedTabChangeListener

public void addSelectedTabChangeListener(Accordion.SelectedTabChangeListener listener)

Description copied from interface: Accordion

Add a listener that will be notified when a selected tab is changed.

Specified by:

addSelectedTabChangeListener in interface Accordion

removeSelectedTabChangeListener

public void removeSelectedTabChangeListener(Accordion.SelectedTabChangeListener listener)

Description copied from interface: Accordion

Remove previously added SelectedTabChangeListener.

Specified by:

removeSelectedTabChangeListener in interface Accordion