Package io.jmix.ui.component.impl

Class AccordionImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixAccordion>

io.jmix.ui.component.impl.AccordionImpl

All Implemented Interfaces:

Accordion, AttachNotifier, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, SupportsChildrenSelection, UiPermissionAware

public class AccordionImpl
extends AbstractComponent<JmixAccordion>
implements Accordion, UiPermissionAware, SupportsChildrenSelection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AccordionImpl.ComponentDescriptor
protected class	AccordionImpl.LazyTabChangeListener
protected class	AccordionImpl.Tab

Nested classes/interfaces inherited from interface io.jmix.ui.component.Accordion

Accordion.SelectedTabChangeEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentLoader.Context	context
protected IconResolver	iconResolver
protected Icons	icons
protected Set<com.vaadin.ui.Component>	lazyTabs
protected boolean	postInitTaskAdded
protected com.vaadin.shared.Registration	selectedTabChangeListenerRegistration
protected ScreenSettingsFacetResolver	settingsFacetResolver
protected Map<com.vaadin.ui.Component,AccordionImpl.ComponentDescriptor>	tabMapping
protected Map<String,AccordionImpl.Tab>	tabs
protected UiComponents	uiComponents

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Accordion

NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
AccordionImpl()

Method Summary

Modifier and Type	Method	Description
void	add(Component component)	Adds a component to this container.
Accordion.Tab	addLazyTab(String name, org.dom4j.Element descriptor, ComponentLoader loader)	INTERNAL.
Subscription	addSelectedTabChangeListener(Consumer<Accordion.SelectedTabChangeEvent> listener)	Adds a listener that will be notified when a selected tab is changed.
Accordion.Tab	addTab(String name, Component childComponent)	Adds a new tab to the component.
void	applyPermission(UiPermissionDescriptor permissionDescriptor)	Change state of subcomponent according to the permissionValue.
void	attached()	Notifies all listeners that component has been attached.
protected JmixAccordion	createComponent()
protected AccordionImpl.LazyTabChangeListener	createLazyTabChangeListener(ComponentContainer tabContent, org.dom4j.Element descriptor, ComponentLoader loader)
protected CssLayout	createLazyTabLayout()
void	detached()	Notifies all listeners that component has been detached.
protected void	fireTabChanged()
void	focus()	Sets focus to this component
Component	getComponent(String id)	Gets a component belonging to the whole components tree below this container.
Collection<Component>	getComponents()	Gets all components belonging to the whole components tree below this container.
String	getDescription()
protected Set<com.vaadin.ui.Component>	getLazyTabs()
Component	getOwnComponent(String id)	Gets component directly owned by this container.
Collection<Component>	getOwnComponents()	Gets all components directly owned by this container.
Stream<Component>	getOwnComponentsStream()	Gets stream of all components directly owned by this container.
AccordionImpl.Tab	getSelectedTab()	Gets selected tab.
Accordion.Tab	getTab(String name)	Gets tab with the provided id.
Component	getTabComponent(String name)	Gets a component that is a content of the tab.
int	getTabIndex()	Gets the tabulator index of the HasTabIndex component.
Collection<Accordion.Tab>	getTabs()	Gets all tabs.
protected void	initComponentTabChangeListener()
protected void	internalRemoveSelectedTabChangeListener(Consumer<Accordion.SelectedTabChangeEvent> listener)
boolean	isChildSelected(Component component)
boolean	isTabCaptionsAsHtml()
protected void	onSelectedTabChangeListener(com.vaadin.ui.TabSheet.SelectedTabChangeEvent event)
void	remove(Component component)	Removes a component from this container.
void	removeAll()	Removes all components from this container.
void	removeAllTabs()	Removes all tabs.
void	removeTab(String name)	Removes tab.
void	setChildSelected(Component childComponent)
void	setDebugId(String id)	INTERNAL.
void	setDescription(String description)	Sets the component's description.
void	setFrame(Frame frame)
void	setSelectedTab(Accordion.Tab tab)	Sets selected tab.
void	setSelectedTab(String name)	Sets 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 io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame

Methods inherited from interface io.jmix.ui.component.Component.Focusable

isFocusable, setFocusable

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.ComponentContainer

add, remove

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponentNN

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

settingsFacetResolver

@Autowired
protected ScreenSettingsFacetResolver settingsFacetResolver

uiComponents

@Autowired
protected UiComponents uiComponents

iconResolver

@Autowired
protected IconResolver iconResolver

icons

@Autowired
protected Icons icons

postInitTaskAdded

protected boolean postInitTaskAdded

context

protected ComponentLoader.Context context

tabs

protected Map<String,AccordionImpl.Tab> tabs

tabMapping

protected Map<com.vaadin.ui.Component,AccordionImpl.ComponentDescriptor> tabMapping

lazyTabs

protected Set<com.vaadin.ui.Component> lazyTabs

selectedTabChangeListenerRegistration

protected com.vaadin.shared.Registration selectedTabChangeListenerRegistration

Constructor Details

AccordionImpl

public AccordionImpl()

Method Details

createComponent

protected JmixAccordion createComponent()

getLazyTabs

protected Set<com.vaadin.ui.Component> getLazyTabs()

add

public void add(Component component)

Description copied from interface: ComponentContainer

Adds a component to this container.

Specified by:

add in interface ComponentContainer

Parameters:

component - a component to add

remove

public void remove(Component component)

Description copied from interface: ComponentContainer

Removes a component from this container.

Specified by:

remove in interface ComponentContainer

Parameters:

component - a component to remove

removeAll

public void removeAll()

Description copied from interface: ComponentContainer

Removes all components from this container.

Specified by:

removeAll in interface ComponentContainer

getOwnComponent

@Nullable
public Component getOwnComponent(String id)

Description copied from interface: HasComponents

Gets component directly owned by this container.

Specified by:

getOwnComponent in interface HasComponents

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(String id)

Description copied from interface: HasComponents

Gets a component belonging to the whole components tree below this container.

Specified by:

getComponent in interface HasComponents

Returns:

component or null if not found

getOwnComponents

public Collection<Component> getOwnComponents()

Description copied from interface: HasComponents

Gets all components directly owned by this container.

Specified by:

getOwnComponents in interface HasComponents

Returns:

all components directly owned by this container

getOwnComponentsStream

public Stream<Component> getOwnComponentsStream()

Description copied from interface: HasComponents

Gets stream of all components directly owned by this container.

Specified by:

getOwnComponentsStream in interface HasComponents

Returns:

stream of all components directly owned by this container

getComponents

public Collection<Component> getComponents()

Description copied from interface: HasComponents

Gets all components belonging to the whole components tree below this container.

Specified by:

getComponents in interface HasComponents

Returns:

all components belonging to the whole components tree below this container

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface Component.HasDescription

Overrides:

getDescription in class AbstractComponent<JmixAccordion>

Returns:

the components description, used in tooltips

setDescription

public void setDescription(@Nullable
 String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Overrides:

setDescription in class AbstractComponent<JmixAccordion>

Parameters:

description - the new description to set

applyPermission

public void applyPermission(UiPermissionDescriptor permissionDescriptor)

Description copied from interface: UiPermissionAware

Change state of subcomponent according to the permissionValue.

Specified by:

applyPermission in interface 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

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

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

setChildSelected

public void setChildSelected(Component childComponent)

Specified by:

setChildSelected in interface SupportsChildrenSelection

isChildSelected

public boolean isChildSelected(Component component)

Specified by:

isChildSelected in interface SupportsChildrenSelection

removeTab

public void removeTab(String name)

Description copied from interface: Accordion

Removes tab.

Specified by:

removeTab in interface Accordion

Parameters:

name - id of the tab to remove

removeAllTabs

public void removeAllTabs()

Description copied from interface: Accordion

Removes all tabs.

Specified by:

removeAllTabs in interface Accordion

addTab

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

Description copied from interface: Accordion

Adds 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(@Nullable
 String id)

Description copied from interface: HasDebugId

INTERNAL. Managed by debug Id system.

Specified by:

setDebugId in interface HasDebugId

Overrides:

setDebugId in class AbstractComponent<JmixAccordion>

addLazyTab

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

Description copied from interface: Accordion

INTERNAL. Adds a new lazy tab to the component.

Specified by:

addLazyTab in interface Accordion

createLazyTabLayout

protected CssLayout createLazyTabLayout()

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<JmixAccordion>

getSelectedTab

@Nullable
public AccordionImpl.Tab getSelectedTab()

Description copied from interface: Accordion

Gets 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

Sets selected tab.

Specified by:

setSelectedTab in interface Accordion

Parameters:

tab - tab instance

setSelectedTab

public void setSelectedTab(String name)

Description copied from interface: Accordion

Sets selected tab.

Specified by:

setSelectedTab in interface Accordion

Parameters:

name - tab id

getTab

@Nullable
public Accordion.Tab getTab(String name)

Description copied from interface: Accordion

Gets tab with the provided id.

Specified by:

getTab in interface Accordion

Parameters:

name - tab id

Returns:

tab instance

getTabComponent

public Component getTabComponent(String name)

Description copied from interface: Accordion

Gets a component that is a content of the tab.

Specified by:

getTabComponent in interface Accordion

Parameters:

name - tab id

Returns:

tab content

getTabs

public Collection<Accordion.Tab> getTabs()

Description copied from interface: Accordion

Gets 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

initComponentTabChangeListener

protected void initComponentTabChangeListener()

fireTabChanged

protected void fireTabChanged()

addSelectedTabChangeListener

public Subscription addSelectedTabChangeListener(Consumer<Accordion.SelectedTabChangeEvent> listener)

Description copied from interface: Accordion

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

Specified by:

addSelectedTabChangeListener in interface Accordion

onSelectedTabChangeListener

protected void onSelectedTabChangeListener(com.vaadin.ui.TabSheet.SelectedTabChangeEvent event)

internalRemoveSelectedTabChangeListener

protected void internalRemoveSelectedTabChangeListener(Consumer<Accordion.SelectedTabChangeEvent> listener)

attached

public void attached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been attached.

Specified by:

attached in interface AttachNotifier

Overrides:

attached in class AbstractComponent<JmixAccordion>

detached

public void detached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been detached.

Specified by:

detached in interface AttachNotifier

Overrides:

detached in class AbstractComponent<JmixAccordion>

createLazyTabChangeListener

protected AccordionImpl.LazyTabChangeListener createLazyTabChangeListener(ComponentContainer tabContent,
 org.dom4j.Element descriptor,
 ComponentLoader loader)