io.jmix.ui.component

Class ComponentsHelper

java.lang.Object

io.jmix.ui.component.ComponentsHelper

public abstract class ComponentsHelper
extends java.lang.Object

Utility class working with GenericUI components.

Method Summary

Modifier and Type	Method and Description
static void	fillErrorMessages(Validatable component, ValidationException e, ValidationErrors errors) Place component with error message to validation errors container.
static Action	findAction(Frame frame, java.lang.String actionId) Searches for action with the given actionId inside of frame.
static Action	findAction(java.lang.String actionName, Frame frame) Searches for an action by name.
static int	findActionById(java.util.List<Action> actionList, java.lang.String actionId)
static Component	findChildComponent(java.util.Collection<Component> components, com.vaadin.ui.Component vaadinSource, com.vaadin.ui.Component target)
static Component	findChildComponent(HasComponents container, com.vaadin.ui.Component target)
static Component	findComponent(Frame frame, java.lang.String id) Searches for a component by identifier, down by the hierarchy of frames.
static Component.Focusable	focusChildComponent(Component container)
static void	focusComponent(Component component) Focus component (or its nearest focusable parent) and activate all its parents, for instance: select Tab, expand GroupBox.
static Component	getComponent(HasComponents container, java.lang.String id)
static java.lang.String	getComponentHeight(Component c)
static java.lang.String	getComponentPath(Component c)
static java.util.Collection<Component>	getComponents(HasComponents container) Returns the collection of components within the specified container and all of its children.
static <T extends com.vaadin.ui.Component> java.util.Collection<T>	getComponents(com.vaadin.ui.HasComponents container, java.lang.Class<T> aClass)
static java.lang.String	getComponentWidth(Component c)
static com.vaadin.ui.Component	getComposition(Component component) Returns underlying Vaadin component, which serves as the outermost container for the supplied GUI component.
static com.vaadin.ui.Component	getDirectChildComponent(com.vaadin.ui.Component targetComponent, com.vaadin.ui.Component vaadinSource)
static Component	getFrameComponent(Frame frame, java.lang.String id)
static java.lang.String	getFullFrameId(Frame frame)
static io.jmix.core.metamodel.model.MetaProperty	getMetaProperty(HasValueSource<?> component)
static io.jmix.core.metamodel.model.MetaPropertyPath	getMetaPropertyPath(HasValueSource<?> component)
static Window	getParentWindow(ScreenFragment frameOwner)
static Screen	getScreen(ScreenFragment frameOwner)
static ScreenContext	getScreenContext(Component.BelongToFrame component) Get screen context for UI component.
static ShortcutTriggeredEvent	getShortcutEvent(Component source, com.vaadin.ui.Component target)
static com.vaadin.ui.Component	getVaadinSource(Component source)
static Window	getWindow(Component.BelongToFrame component) Get the topmost window for the specified component.
static Component	getWindowComponent(Window window, java.lang.String id)
static Window	getWindowImplementation(Component.BelongToFrame component) Get the topmost window for the specified component.
static Window	getWindowNN(Component.BelongToFrame component)
static boolean	isComponentEnabled(com.vaadin.ui.Component child) Tests if component enabled and visible and its container enabled.
static boolean	isComponentExpanded(Component component)
static boolean	isComponentVisible(com.vaadin.ui.Component child) Tests if component visible and its container visible.
static boolean	isComponentVisibleToClient(com.vaadin.ui.Component child) Checks if the component should be visible to the client.
static void	setClickShortcut(com.vaadin.ui.Button button, java.lang.String shortcut)
static void	setStyleName(Component component, java.lang.String styleName, boolean add) Null-safe helper analog of Component.addStyleName(String) and Component.removeStyleName(String)
static void	traverseComponents(HasComponents container, java.util.function.Consumer<Component> visitor) Visit all components below the specified container.
static void	traverseValidatable(HasComponents container, java.util.function.Consumer<Validatable> visitor) Visit all Validatable components below the specified container.
static com.vaadin.ui.Component	unwrap(Component component) Returns underlying Vaadin component implementation.
static boolean	walkComponents(HasComponents container, ComponentFinder finder) Iterates over all components applying finder instance.
static void	walkComponents(HasComponents container, ComponentVisitor visitor) Visit all components below the specified container.

Methods inherited from class java.lang.Object

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

Method Detail

getComponents

public static java.util.Collection<Component> getComponents(HasComponents container)

Returns the collection of components within the specified container and all of its children.

Parameters:

container - container to start from

Returns:

collection of components

traverseComponents

public static void traverseComponents(HasComponents container,
                                      java.util.function.Consumer<Component> visitor)

Visit all components below the specified container.

Parameters:

container - container to start from

visitor - visitor instance

traverseValidatable

public static void traverseValidatable(HasComponents container,
                                       java.util.function.Consumer<Validatable> visitor)

Visit all Validatable components below the specified container.

Parameters:

container - container to start from

visitor - visitor instance

getWindowComponent

@Nullable
public static Component getWindowComponent(Window window,
                                                     java.lang.String id)

getFrameComponent

@Nullable
public static Component getFrameComponent(Frame frame,
                                                    java.lang.String id)

getComponent

@Nullable
public static Component getComponent(HasComponents container,
                                               java.lang.String id)

findComponent

@Nullable
public static Component findComponent(Frame frame,
                                                java.lang.String id)

Searches for a component by identifier, down by the hierarchy of frames.

Parameters:

frame - frame to start from

id - component identifier

Returns:

component instance or null if not found

walkComponents

public static void walkComponents(HasComponents container,
                                  ComponentVisitor visitor)

Visit all components below the specified container.

Parameters:

container - container to start from

visitor - visitor instance

walkComponents

public static boolean walkComponents(HasComponents container,
                                     ComponentFinder finder)

Iterates over all components applying finder instance. Stops when the component is found and returns true. If no component is found returns false.

Parameters:

container - container to start from

finder - finder instance

Returns:

true if component has been found, false otherwise

getWindow

@Nullable
public static Window getWindow(Component.BelongToFrame component)

Get the topmost window for the specified component.

Parameters:

component - component instance

Returns:

topmost window in the hierarchy of frames for this component.
Can be null only if the component wasn't properly initialized.

getWindowNN

public static Window getWindowNN(Component.BelongToFrame component)

getScreenContext

public static ScreenContext getScreenContext(Component.BelongToFrame component)

Get screen context for UI component.

Parameters:

component - component

Returns:

screen context

Throws:

java.lang.IllegalStateException - in case window cannot be inferred

getScreen

@Nullable
public static Screen getScreen(ScreenFragment frameOwner)

getParentWindow

@Nullable
public static Window getParentWindow(ScreenFragment frameOwner)

getWindowImplementation

@Nullable
public static Window getWindowImplementation(Component.BelongToFrame component)

Get the topmost window for the specified component.

Parameters:

component - component instance

Returns:

topmost client specific window in the hierarchy of frames for this component.
Can be null only if the component wasn't properly initialized.

getFullFrameId

public static java.lang.String getFullFrameId(Frame frame)

findAction

@Nullable
public static Action findAction(java.lang.String actionName,
                                          Frame frame)

Searches for an action by name.

Parameters:

actionName - action name, can be a path to an action contained in some ActionsHolder

frame - current frame

Returns:

action instance or null if there is no action with the specified name

Throws:

java.lang.IllegalStateException - if the component denoted by the path doesn't exist or is not an ActionsHolder

getComponentPath

public static java.lang.String getComponentPath(Component c)

getComponentWidth

public static java.lang.String getComponentWidth(Component c)

getComponentHeight

public static java.lang.String getComponentHeight(Component c)

fillErrorMessages

public static void fillErrorMessages(Validatable component,
                                     ValidationException e,
                                     ValidationErrors errors)

Place component with error message to validation errors container.

Parameters:

component - validatable component

e - exception

errors - errors container

findActionById

public static int findActionById(java.util.List<Action> actionList,
                                 java.lang.String actionId)

focusComponent

public static void focusComponent(Component component)

Focus component (or its nearest focusable parent) and activate all its parents, for instance: select Tab, expand GroupBox.

Parameters:

component - component

focusChildComponent

@Nullable
public static Component.Focusable focusChildComponent(Component container)

setStyleName

public static void setStyleName(@Nullable
                                Component component,
                                java.lang.String styleName,
                                boolean add)

Null-safe helper analog of Component.addStyleName(String) and Component.removeStyleName(String)

Adds or removes a style name. Multiple styles can be specified as a space-separated list of style names.

If the add parameter is true, the style name is added to the component. If the add parameter is false, the style name is removed from the component.

Parameters:

component - component

styleName - style name to add or remove

add - add style name, or remove

findAction

@Nullable
public static Action findAction(Frame frame,
                                          java.lang.String actionId)

Searches for action with the given actionId inside of frame.

Parameters:

frame - frame

actionId - action id

Returns:

action instance or null if action not found

getComponents

public static <T extends com.vaadin.ui.Component> java.util.Collection<T> getComponents(com.vaadin.ui.HasComponents container,
                                                                                        java.lang.Class<T> aClass)

unwrap

public static com.vaadin.ui.Component unwrap(Component component)

Returns underlying Vaadin component implementation.

Parameters:

component - GUI component

Returns:

Vaadin component

See Also:

getComposition(io.jmix.ui.component.Component)

getComposition

public static com.vaadin.ui.Component getComposition(Component component)

Returns underlying Vaadin component, which serves as the outermost container for the supplied GUI component. For simple components like Button this method returns the same result as unwrap(io.jmix.ui.component.Component).

Parameters:

component - GUI component

Returns:

Vaadin component

See Also:

unwrap(io.jmix.ui.component.Component)

isComponentVisibleToClient

public static boolean isComponentVisibleToClient(com.vaadin.ui.Component child)

Checks if the component should be visible to the client. Returns false if the child should not be sent to the client, true otherwise.

Parameters:

child - The child to check

Returns:

true if the child is visible to the client, false otherwise

isComponentVisible

public static boolean isComponentVisible(com.vaadin.ui.Component child)

Tests if component visible and its container visible.

Parameters:

child - component

Returns:

component visibility

isComponentEnabled

public static boolean isComponentEnabled(com.vaadin.ui.Component child)

Tests if component enabled and visible and its container enabled.

Parameters:

child - component

Returns:

component enabled state

isComponentExpanded

public static boolean isComponentExpanded(Component component)

getShortcutEvent

public static ShortcutTriggeredEvent getShortcutEvent(Component source,
                                                      com.vaadin.ui.Component target)

getVaadinSource

public static com.vaadin.ui.Component getVaadinSource(Component source)

findChildComponent

@Nullable
public static Component findChildComponent(HasComponents container,
                                                     com.vaadin.ui.Component target)

findChildComponent

@Nullable
public static Component findChildComponent(java.util.Collection<Component> components,
                                                     com.vaadin.ui.Component vaadinSource,
                                                     com.vaadin.ui.Component target)

getDirectChildComponent

@Nullable
public static com.vaadin.ui.Component getDirectChildComponent(com.vaadin.ui.Component targetComponent,
                                                                        com.vaadin.ui.Component vaadinSource)

Returns:

the direct child component of the layout which contains the component involved to event

setClickShortcut

public static void setClickShortcut(com.vaadin.ui.Button button,
                                    java.lang.String shortcut)

getMetaPropertyPath

@Nullable
public static io.jmix.core.metamodel.model.MetaPropertyPath getMetaPropertyPath(HasValueSource<?> component)

getMetaProperty

@Nullable
public static io.jmix.core.metamodel.model.MetaProperty getMetaProperty(HasValueSource<?> component)