Package io.jmix.ui.component.impl

Class FragmentImpl

java.lang.Object

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

io.jmix.ui.component.impl.AbstractBox<JmixVerticalActionsLayout>

io.jmix.ui.component.impl.VBoxLayoutImpl

io.jmix.ui.component.impl.FragmentImpl

All Implemented Interfaces:

ActionsHolder, AttachNotifier, BoxLayout, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Fragment, Frame, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasMargin, HasRequiredIndicator, HasSpacing, HasSubParts, FragmentImplementation, FrameImplementation, LayoutClickNotifier, OrderedContainer, ShortcutNotifier, SupportsExpandRatio, VBoxLayout

public class FragmentImpl
extends VBoxLayoutImpl
implements Fragment, FragmentImplementation

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

ExpandingLayout.ExpandDirection

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 FrameActionsHolder	actionsHolder
protected Map<String,Component>	allComponents
protected FrameContext	context
protected Set<Facet>	facets
protected ScreenFragment	frameOwner

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

layoutClickRegistration, ownComponents, 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

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

NAME

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

NAME

Constructor Summary

Constructors

Constructor	Description
FragmentImpl()

Method Summary

Modifier and Type	Method	Description
void	add(Component childComponent, int index)
void	addAction(Action action)	Add an action to the component
void	addAction(Action action, int index)	Add an action to the component with index.
void	addFacet(Facet facet)	Registers the passed non-visual component in the frame.
void	attached()	Notifies all listeners that component has been attached.
protected void	attachToFrame(Component childComponent)
void	detached()	Notifies all listeners that component has been detached.
protected void	disableEventListeners()
protected void	enableEventListeners()
Action	getAction(String id)
Collection<Action>	getActions()
Component	getComponent(String id)	Gets a component belonging to the whole components tree below this container.
FrameContext	getContext()
Facet	getFacet(String id)	Finds registered facet by ID.
Stream<Facet>	getFacets()
ScreenFragment	getFrameOwner()
Component	getRegisteredComponent(String id)	INTERNAL.
protected boolean	handleValidationErrors(ValidationErrors errors)
protected void	initComponent(JmixVerticalActionsLayout component)
void	initUiEventListeners()
boolean	isValid()	Check validity by invoking validators on all components which support them.
void	registerComponent(Component component)	INTERNAL.
void	removeAction(Action action)	Remove the action from the component
void	removeAction(String id)	Remove the action by its ID.
void	removeAllActions()	Remove all actions from the component
void	removeFacet(Facet facet)	Removes the non-visual component from the frame.
void	setContext(FrameContext ctx)	INTERNAL.
void	setFrame(Frame frame)
void	setFrameOwner(ScreenFragment controller)
void	unregisterComponent(Component component)	INTERNAL.
void	validate()	Check validity by invoking validators on all components which support them.
boolean	validate(List<Validatable> fields)	Check validity by invoking validators on specified components which support them and show validation result notification.
boolean	validateAll()	Check validity by invoking validators on all components which support them and show validation result notification.

Methods inherited from class io.jmix.ui.component.impl.VBoxLayoutImpl

createComponent, getExpandDirection

Methods inherited from class io.jmix.ui.component.impl.AbstractBox

add, addLayoutClickListener, addShortcutAction, expand, findChildComponent, getComponent, getComponents, getExpandRatio, getMargin, getOwnComponent, getOwnComponents, getOwnComponentsStream, getSpacing, indexOf, internalRemoveLayoutClickListener, isExpanded, isRequiredIndicatorVisible, remove, removeAll, removeShortcutAction, resetExpanded, setExpandRatio, setMargin, setRequiredIndicatorVisible, setSpacing

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

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, 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, setDescription, 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.ActionsHolder

getActionNN, getSubPart

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

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

add, add, remove, remove, removeAll

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

expand, getExpandDirection, isExpanded, resetExpanded

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

getFacetNN

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

focusFirstComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

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

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

getMargin, setMargin, setMargin, setMargin

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

getSpacing, setSpacing

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

addLayoutClickListener

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

getComponent, getComponentNN, indexOf

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

addShortcutAction, removeShortcutAction

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

getExpandRatio, setExpandRatio

Field Details

context

protected FrameContext context

frameOwner

protected ScreenFragment frameOwner

facets

protected Set<Facet> facets

allComponents

protected Map<String,Component> allComponents

actionsHolder

protected FrameActionsHolder actionsHolder

Constructor Details

FragmentImpl

public FragmentImpl()

Method Details

initComponent

protected void initComponent(JmixVerticalActionsLayout component)

Overrides:

initComponent in class VBoxLayoutImpl

addFacet

public void addFacet(Facet facet)

Description copied from interface: Frame

Registers the passed non-visual component in the frame.

Specified by:

addFacet in interface Frame

Parameters:

facet - facet

getFacet

@Nullable
public Facet getFacet(String id)

Description copied from interface: Frame

Finds registered facet by ID.

Specified by:

getFacet in interface Frame

Parameters:

id - facet ID

Returns:

facet instance or null

removeFacet

public void removeFacet(Facet facet)

Description copied from interface: Frame

Removes the non-visual component from the frame.

Specified by:

removeFacet in interface Frame

Parameters:

facet - facet

getFacets

public Stream<Facet> getFacets()

Specified by:

getFacets in interface Frame

Returns:

stream of registered non-visual components

add

public void add(Component childComponent,
 int index)

Specified by:

add in interface OrderedContainer

Overrides:

add in class AbstractBox<JmixVerticalActionsLayout>

attachToFrame

protected void attachToFrame(Component childComponent)

Overrides:

attachToFrame in class AbstractBox<JmixVerticalActionsLayout>

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractBox<JmixVerticalActionsLayout>

getFrameOwner

public ScreenFragment getFrameOwner()

Specified by:

getFrameOwner in interface Fragment

Specified by:

getFrameOwner in interface Frame

Returns:

UI controller of the frame

See Also:

• Screen
• ScreenFragment

getContext

public FrameContext getContext()

Specified by:

getContext in interface Fragment

Specified by:

getContext in interface Frame

Returns:

current frame context

setContext

public void setContext(FrameContext ctx)

Description copied from interface: FrameImplementation

INTERNAL. Don't call from application code.

Specified by:

setContext in interface FrameImplementation

registerComponent

public void registerComponent(Component component)

Description copied from interface: FrameImplementation

INTERNAL. Don't call from application code.

Specified by:

registerComponent in interface FrameImplementation

unregisterComponent

public void unregisterComponent(Component component)

Description copied from interface: FrameImplementation

INTERNAL. Don't call from application code.

Specified by:

unregisterComponent in interface FrameImplementation

getRegisteredComponent

@Nullable
public Component getRegisteredComponent(String id)

Description copied from interface: FrameImplementation

INTERNAL. Don't call from application code.

Specified by:

getRegisteredComponent in interface FrameImplementation

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

Overrides:

getComponent in class AbstractBox<JmixVerticalActionsLayout>

Returns:

component or null if not found

isValid

public boolean isValid()

Description copied from interface: Frame

Check validity by invoking validators on all components which support them.

Specified by:

isValid in interface Frame

Returns:

true if all components are in valid state

validate

public void validate()
              throws ValidationException

Description copied from interface: Frame

Check validity by invoking validators on all components which support them.

Specified by:

validate in interface Frame

Throws:

ValidationException - if some components are currently in invalid state

validate

public boolean validate(List<Validatable> fields)

Description copied from interface: Frame

Check validity by invoking validators on specified components which support them and show validation result notification.

Specified by:

validate in interface Frame

Returns:

true if the validation was successful, false if there were any problems

validateAll

public boolean validateAll()

Description copied from interface: Frame

Check validity by invoking validators on all components which support them and show validation result notification.

Specified by:

validateAll in interface Frame

Returns:

true if the validation was successful, false if there were any problems

handleValidationErrors

protected boolean handleValidationErrors(ValidationErrors errors)

addAction

public void addAction(Action action)

Description copied from interface: ActionsHolder

Add an action to the component

Specified by:

addAction in interface ActionsHolder

addAction

public void addAction(Action action,
 int index)

Description copied from interface: ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface ActionsHolder

removeAction

public void removeAction(Action action)

Description copied from interface: ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface ActionsHolder

removeAction

public void removeAction(String id)

Description copied from interface: ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface ActionsHolder

getActions

public Collection<Action> getActions()

Specified by:

getActions in interface ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(String id)

Specified by:

getAction in interface ActionsHolder

Returns:

an action by its ID, or null if not found

setFrameOwner

public void setFrameOwner(ScreenFragment controller)

Specified by:

setFrameOwner in interface FragmentImplementation

initUiEventListeners

public void initUiEventListeners()

Specified by:

initUiEventListeners in interface FragmentImplementation

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 AbstractBox<JmixVerticalActionsLayout>

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 AbstractBox<JmixVerticalActionsLayout>

disableEventListeners

protected void disableEventListeners()

enableEventListeners

protected void enableEventListeners()