Package io.jmix.ui.component.impl

Class AbstractOrderedLayout<T extends com.vaadin.ui.CssLayout>

java.lang.Object

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

io.jmix.ui.component.impl.AbstractOrderedLayout<T>

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, LayoutClickNotifier, OrderedContainer, ShortcutNotifier

Direct Known Subclasses:

CssLayoutImpl, FlowBoxLayoutImpl

public class AbstractOrderedLayout<T extends com.vaadin.ui.CssLayout>
extends AbstractComponent<T>
implements OrderedContainer, Component.BelongToFrame, Component.HasCaption, Component.HasIcon, LayoutClickNotifier, ShortcutNotifier

Nested Class Summary

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

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

LayoutClickNotifier.LayoutClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.shared.Registration	layoutClickRegistration
protected List<Component>	ownComponents
protected Map<ShortcutAction,com.vaadin.event.ShortcutListener>	shortcuts

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
AbstractOrderedLayout()

Method Summary

Modifier and Type	Method	Description
void	add(Component childComponent)	Adds a component to this container.
void	add(Component childComponent, int index)
Subscription	addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)	Adds a listener that is fired when user clicks inside the layout at any place.
void	addShortcutAction(ShortcutAction action)
void	attached()	Notifies all listeners that component has been attached.
void	detached()	Notifies all listeners that component has been detached.
protected Component	findChildComponent(ComponentContainer layout, com.vaadin.ui.Component clickedComponent)
Component	getComponent(int index)	Returns the component at the given position.
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()
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.
int	indexOf(Component component)
protected void	internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
void	remove(Component childComponent)	Removes a component from this container.
void	removeAll()	Removes all components from this container.
void	removeShortcutAction(ShortcutAction action)
void	setDescription(String description)	Sets the component's description.
void	setFrame(Frame frame)

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, setDebugId, 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.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.OrderedContainer

getComponentNN

Field Details

ownComponents

protected List<Component> ownComponents

layoutClickRegistration

protected com.vaadin.shared.Registration layoutClickRegistration

shortcuts

protected Map<ShortcutAction,com.vaadin.event.ShortcutListener> shortcuts

Constructor Details

AbstractOrderedLayout

public AbstractOrderedLayout()

Method Details

add

public void add(Component childComponent)

Description copied from interface: ComponentContainer

Adds a component to this container.

Specified by:

add in interface ComponentContainer

Parameters:

childComponent - a component to add

add

public void add(Component childComponent,
 int index)

Specified by:

add in interface OrderedContainer

indexOf

public int indexOf(Component component)

Specified by:

indexOf in interface OrderedContainer

getComponent

@Nullable
public Component getComponent(int index)

Description copied from interface: OrderedContainer

Returns the component at the given position.

Specified by:

getComponent in interface OrderedContainer

Parameters:

index - component index

Returns:

the component at the given index or null.

remove

public void remove(Component childComponent)

Description copied from interface: ComponentContainer

Removes a component from this container.

Specified by:

remove in interface ComponentContainer

Parameters:

childComponent - 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

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<T extends com.vaadin.ui.CssLayout>

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<T extends com.vaadin.ui.CssLayout>

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<T extends com.vaadin.ui.CssLayout>

Parameters:

description - the new description to set

addLayoutClickListener

public Subscription addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)

Description copied from interface: LayoutClickNotifier

Adds a listener that is fired when user clicks inside the layout at any place.

Specified by:

addLayoutClickListener in interface LayoutClickNotifier

Parameters:

listener - a listener to add

findChildComponent

@Nullable
protected Component findChildComponent(ComponentContainer layout,
 com.vaadin.ui.Component clickedComponent)

internalRemoveLayoutClickListener

protected void internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)

addShortcutAction

public void addShortcutAction(ShortcutAction action)

Specified by:

addShortcutAction in interface ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(ShortcutAction action)

Specified by:

removeShortcutAction in interface ShortcutNotifier

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<T extends com.vaadin.ui.CssLayout>

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<T extends com.vaadin.ui.CssLayout>