com.haulmont.cuba.gui.components

Class AbstractFrame

java.lang.Object

com.haulmont.cuba.gui.screen.ScreenFragment

com.haulmont.cuba.gui.components.AbstractFrame

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, Frame.Wrapper, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SupportsExpandRatio, LegacyFrame, FrameOwner

Direct Known Subclasses:

AbstractLocalizedTextFieldsFrame, AttributePermissionsFrame, AttributesLocationFrame, CategoryAttrsFrame, ConditionFrame, CreditsFrame, EntityDiffViewer, EntityOpenHistoryFrame, EntityPermissionsFrame, RuntimePropertiesFrame, ScreenFragmentWrapper, ScreenPermissionsFrame, SpecificPermissionsFrame, UiPermissionsFrame

public class AbstractFrame
extends ScreenFragment
implements Frame, Frame.Wrapper, LegacyFrame

Base class for frame controllers.

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.screen.ScreenFragment

ScreenFragment.AfterInitEvent, ScreenFragment.AttachEvent, ScreenFragment.DetachEvent, ScreenFragment.InitEvent

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.Wrapper

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

ExpandingLayout.ExpandDirection

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Frame	frame
protected Messages	messages

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

NAME

Fields inherited from interface com.haulmont.cuba.gui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
AbstractFrame()

Method Summary

Modifier and Type	Method and Description
void	add(Component component) Adds a component to this container.
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	addStyleName(java.lang.String styleName) Adds one or more style names to this component.
void	dispose() Disposes frame references.
void	expand(Component component)
void	expand(Component component, java.lang.String height, java.lang.String width)
protected java.lang.String	formatMessage(java.lang.String key, java.lang.Object... params) Get localized message from the message pack associated with this frame or window, and use it as a format string for parameters provided.
Action	getAction(java.lang.String id)
java.util.Collection<Action>	getActions()
Component.Alignment	getAlignment()
java.lang.String	getCaption()
<T> T	getCompanion()
java.lang.Object	getComponent()
Component	getComponent(int index) Returns the component at the given position.
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.Object	getComposition()
FrameContext	getContext()
java.lang.String	getDescription()
DsContext	getDsContext()
ExpandingLayout.ExpandDirection	getExpandDirection()
float	getExpandRatio(Component component)
Facet	getFacet(java.lang.String id) Finds registered facet by ID.
java.util.stream.Stream<Facet>	getFacets()
Frame	getFrame()
FrameOwner	getFrameOwner()
float	getHeight() Get component height in Component.getHeightSizeUnit()
SizeUnit	getHeightSizeUnit() Gets the height property units.
java.lang.String	getIcon() Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
MarginInfo	getMargin()
protected java.lang.String	getMessage(java.lang.String key) Get localized message from the message pack associated with this frame or window.
java.lang.String	getMessagesPack()
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
java.util.stream.Stream<Component>	getOwnComponentsStream() Get stream of components directly owned by this container
Component	getParent()
boolean	getSpacing()
java.lang.String	getStyleName() Styles implementation is client-type-specific.
float	getWidth() Get component width in Component.getWidthUnits()
SizeUnit	getWidthSizeUnit() Gets the width property units.
WindowManager	getWindowManager() It is recommended to use Screens instead, it can be obtained from ScreenContext of FrameOwner.
Frame	getWrappedFrame()
int	indexOf(Component component)
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
protected void	init(ScreenFragment.InitEvent initEvent)
boolean	isEnabled() Is the component enabled? Note that this method only returns the status of the component and does not take parents into account.
boolean	isEnabledRecursive()
boolean	isExpanded(Component component)
boolean	isResponsive() Is the component responsive?
boolean	isValid() Check validity by invoking validators on all components which support them.
boolean	isVisible() Is the component visible? A component is visible only if all its parents are also visible.
boolean	isVisibleRecursive()
void	remove(Component component) Removes a component from this container.
void	removeAction(Action action) Remove the action from the component
void	removeAction(java.lang.String id) Remove the action by its ID.
void	removeAll() Removes all components from this container.
void	removeAllActions() Remove all actions from the component
void	removeFacet(Facet facet) Removes the non-visual component from the frame.
void	removeStyleName(java.lang.String styleName) Removes one or more style names from component.
void	resetExpanded()
void	setAlignment(Component.Alignment alignment)
void	setCaption(java.lang.String caption) Sets the component's caption.
void	setCompanion(java.lang.Object companion) INTERNAL.
void	setDescription(java.lang.String description) Sets the component's description.
void	setDsContext(DsContext dsContext) INTERNAL.
void	setEnabled(boolean enabled) Sets the component enabled state.
void	setExpandRatio(Component component, float ratio) Sets expand ratio for the component.
protected void	setFragment(Fragment fragment)
void	setFrame(Frame frame)
void	setHeight(java.lang.String height) Set component height in Component.getHeightUnits()
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon) Set an icon from an icon set.
void	setId(java.lang.String id) Sets id of the screen fragment.
void	setMargin(MarginInfo marginInfo)
void	setMessagesPack(java.lang.String name)
void	setParent(Component parent) INTERNAL. ComponentContainer.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setResponsive(boolean responsive) Sets component to be responsive by width and height.
void	setSpacing(boolean enabled)
void	setStyleName(java.lang.String styleName) Sets one or more style names of the component, replacing any previous styles.
void	setVisible(boolean visible) Sets visibility value for the component.
void	setWidth(java.lang.String width) Set component width in Component.getWidthSizeUnit()}
void	setWrappedFrame(Frame frame) INTERNAL.
void	showValidationErrors(ValidationErrors errors) Show validation errors alert.
<X> X	unwrap(java.lang.Class<X> internalComponentClass) Get client specific component instance.
<X> X	unwrapComposition(java.lang.Class<X> internalCompositionClass) Get the outmost external container of client specific component instance.
void	validate() Check validity by invoking validators on all components which support them.
boolean	validate(java.util.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 com.haulmont.cuba.gui.screen.ScreenFragment

addAfterInitListener, addAttachEventListener, addDetachEventListener, addInitListener, fireEvent, getBeanLocator, getEventHub, getExtensions, getFragment, getHostController, getHostScreen, getId, getScreenData, getUiEventListeners, init, setBeanLocator, setExtensions, setHostController, setScreenData, setUiEventListeners

Methods inherited from class java.lang.Object

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

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

getFacetNN

Methods inherited from interface com.haulmont.cuba.gui.screen.compatibility.LegacyFrame

getXmlDescriptor, setXmlDescriptor

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

getActionNN, getSubPart

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

setMargin, setMargin

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

getComponentNN

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

add, focusFirstComponent, getComponentNN, remove

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

getHeightUnits, getId, getWidthUnits, isEnabledItself, isVisibleItself, requestFocus, setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

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

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Field Detail

frame

protected Frame frame

messages

@Inject
protected Messages messages

Constructor Detail

AbstractFrame

public AbstractFrame()

Method Detail

setFragment

protected void setFragment(Fragment fragment)

Overrides:

setFragment in class ScreenFragment

getWindowManager

public WindowManager getWindowManager()

Description copied from interface: HasWindowManager

It is recommended to use Screens instead, it can be obtained from ScreenContext of FrameOwner.

Specified by:

getWindowManager in interface HasWindowManager

getWrappedFrame

public Frame getWrappedFrame()

Specified by:

getWrappedFrame in interface Frame.Wrapper

setWrappedFrame

public void setWrappedFrame(Frame frame)

INTERNAL. Don't call from application code.

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

init

@Order(value=110)
 @Subscribe
protected void init(ScreenFragment.InitEvent initEvent)

setId

public void setId(java.lang.String id)

Description copied from class: ScreenFragment

Sets id of the screen fragment. Called by the framework during screen init to assign screen id.

Specified by:

setId in interface Component

Overrides:

setId in class ScreenFragment

Parameters:

id - screen id

getParent

public Component getParent()

Specified by:

getParent in interface Component

Returns:

parent of component.

setParent

public void setParent(Component parent)

Description copied from interface: Component

INTERNAL.
ComponentContainer.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Parameters:

parent - Parent component

isEnabled

public boolean isEnabled()

Description copied from interface: Component

Is the component enabled?
Note that this method only returns the status of the component and does not take parents into account. Even though this method returns true the component can be disabled to the user if a parent is disabled.

Specified by:

isEnabled in interface Component

Returns:

true if the component enabled flag is set to true

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Component

Sets the component enabled state.
The user can not interact with disabled components, which are shown with a style that indicates the status. Components are enabled by default.

Specified by:

setEnabled in interface Component

Parameters:

enabled - enabled flag

isEnabledRecursive

public boolean isEnabledRecursive()

Specified by:

isEnabledRecursive in interface Component

Returns:

true if the component and all its parent components are enabled

isVisible

public boolean isVisible()

Description copied from interface: Component

Is the component visible?
A component is visible only if all its parents are also visible. This is not checked by this method though, so even if this method returns true, the component can be hidden from the user because a parent is set to invisible.

Specified by:

isVisible in interface Component

Returns:

true if the component visibility is set to true

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

Sets visibility value for the component.
Visible components are drawn in the user interface, while invisible ones are not. The effect is not a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent.

Specified by:

setVisible in interface Component

Parameters:

visible - visible flag

isVisibleRecursive

public boolean isVisibleRecursive()

Specified by:

isVisibleRecursive in interface Component

Returns:

true if the component and all its parent components are visible

getHeight

public float getHeight()

Description copied from interface: Component

Get component height in Component.getHeightSizeUnit()

Specified by:

getHeight in interface Component

setHeight

public void setHeight(java.lang.String height)

Description copied from interface: Component

Set component height in Component.getHeightUnits()

Specified by:

setHeight in interface Component

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Description copied from interface: Component

Gets the height property units.

Specified by:

getHeightSizeUnit in interface Component

Returns:

units used in height property.

getWidth

public float getWidth()

Description copied from interface: Component

Get component width in Component.getWidthUnits()

Specified by:

getWidth in interface Component

setWidth

public void setWidth(java.lang.String width)

Description copied from interface: Component

Set component width in Component.getWidthSizeUnit()}

Specified by:

setWidth in interface Component

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Description copied from interface: Component

Gets the width property units.

Specified by:

getWidthSizeUnit in interface Component

Returns:

units used in the width property.

getAlignment

public Component.Alignment getAlignment()

Specified by:

getAlignment in interface Component

setAlignment

public void setAlignment(Component.Alignment alignment)

Specified by:

setAlignment in interface Component

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Returns:

the caption of the component

setCaption

public void setCaption(java.lang.String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Parameters:

caption - the new component's caption

isResponsive

public boolean isResponsive()

Description copied from interface: Component

Is the component responsive?

Specified by:

isResponsive in interface Component

Returns:

true if the component applies conditional CSS rules for width / height sizes.

setResponsive

public void setResponsive(boolean responsive)

Description copied from interface: Component

Sets component to be responsive by width and height.
If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.

Specified by:

setResponsive in interface Component

Parameters:

responsive - responsive flag

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasDescription

Returns:

the components description, used in tooltips

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Parameters:

description - the new description to set

getIcon

public java.lang.String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

setIcon

public void setIcon(java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

setIconFromSet

public void setIconFromSet(Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

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

public Component getOwnComponent(java.lang.String id)

Description copied from interface: ComponentContainer

Get component directly owned by this container.

Specified by:

getOwnComponent in interface ComponentContainer

Returns:

component or null if not found

getComponent

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

Description copied from interface: ComponentContainer

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

Specified by:

getComponent in interface ComponentContainer

Returns:

component or null if not found

getOwnComponents

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

Description copied from interface: ComponentContainer

Get all components directly owned by this container

Specified by:

getOwnComponents in interface ComponentContainer

getOwnComponentsStream

public java.util.stream.Stream<Component> getOwnComponentsStream()

Description copied from interface: ComponentContainer

Get stream of components directly owned by this container

Specified by:

getOwnComponentsStream in interface ComponentContainer

getComponents

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

Description copied from interface: ComponentContainer

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

Specified by:

getComponents in interface ComponentContainer

getComponent

public java.lang.Object getComponent()

Specified by:

getComponent in interface Component.Wrapper

getComposition

public java.lang.Object getComposition()

Specified by:

getComposition in interface Component.Wrapper

expand

public void expand(Component component,
                   java.lang.String height,
                   java.lang.String width)

Specified by:

expand in interface ExpandingLayout

expand

public void expand(Component component)

Specified by:

expand in interface ExpandingLayout

resetExpanded

public void resetExpanded()

Specified by:

resetExpanded in interface ExpandingLayout

isExpanded

public boolean isExpanded(Component component)

Specified by:

isExpanded in interface ExpandingLayout

getExpandDirection

public ExpandingLayout.ExpandDirection getExpandDirection()

Specified by:

getExpandDirection in interface ExpandingLayout

getFrameOwner

public FrameOwner getFrameOwner()

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 Frame

Specified by:

getContext in interface LegacyFrame

Returns:

current frame context

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface LegacyFrame

Returns:

DsContext of the current frame or window

setDsContext

public void setDsContext(DsContext dsContext)

Description copied from interface: LegacyFrame

INTERNAL. Don't call from application code.

Specified by:

setDsContext in interface LegacyFrame

getMessagesPack

public java.lang.String getMessagesPack()

Specified by:

getMessagesPack in interface LegacyFrame

setMessagesPack

public void setMessagesPack(java.lang.String name)

Specified by:

setMessagesPack in interface LegacyFrame

getMessage

protected java.lang.String getMessage(java.lang.String key)

Get localized message from the message pack associated with this frame or window.

Parameters:

key - message key

Returns:

localized message

See Also:

Messages.getMessage(String, String)

formatMessage

protected java.lang.String formatMessage(java.lang.String key,
                                         java.lang.Object... params)

Get localized message from the message pack associated with this frame or window, and use it as a format string for parameters provided.

Parameters:

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

See Also:

Messages.formatMessage(String, String, Object...)

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

Specified by:

isValid in interface LegacyFrame

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

Specified by:

validate in interface LegacyFrame

Throws:

ValidationException - if some components are currently in invalid state

validate

public boolean validate(java.util.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

Specified by:

validate in interface LegacyFrame

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

Specified by:

validateAll in interface LegacyFrame

Returns:

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

showValidationErrors

public void showValidationErrors(ValidationErrors errors)

Show validation errors alert. Can be overridden in subclasses.

Parameters:

errors - the list of validation errors. Caller fills it by errors found during the default validation.

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.

getCompanion

@Nullable
public <T> T getCompanion()

Specified by:

getCompanion in interface LegacyFrame

Returns:

a companion implementation, specific for the current client type

setCompanion

public void setCompanion(java.lang.Object companion)

INTERNAL. Don't call from application code.

getFrame

public Frame getFrame()

Specified by:

getFrame in interface Component.BelongToFrame

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

getStyleName

public java.lang.String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Returns:

current style name.

setStyleName

public void setStyleName(java.lang.String styleName)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

addStyleName

public void addStyleName(java.lang.String styleName)

Description copied from interface: Component

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

addStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

removeStyleName

public void removeStyleName(java.lang.String styleName)

Description copied from interface: Component

Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

removeStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

unwrap

public <X> X unwrap(java.lang.Class<X> internalComponentClass)

Description copied from interface: Component

Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);
 

Specified by:

unwrap in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalComponentClass - class of underlying component implementation based on Vaadin or Swing

Returns:

internal client specific component

unwrapComposition

public <X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)

Description copied from interface: Component

Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.Layout vLayout = table.unwrapComposition(com.vaadin.ui.Layout.class);
 

Specified by:

unwrapComposition in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing

Returns:

internal client specific component

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface HasSpacing

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface HasSpacing

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface HasMargin

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface HasMargin

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(@Nullable
                         Action action)

Description copied from interface: ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface ActionsHolder

removeAction

public void removeAction(@Nullable
                         java.lang.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 java.util.Collection<Action> getActions()

Specified by:

getActions in interface ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(java.lang.String id)

Specified by:

getAction in interface ActionsHolder

Returns:

an action by its ID, or null if not found

setExpandRatio

public void setExpandRatio(Component component,
                           float ratio)

Description copied from interface: SupportsExpandRatio

Sets expand ratio for the component. The ratio must be greater than or equal to 0.

Specified by:

setExpandRatio in interface SupportsExpandRatio

Parameters:

component - component to expand with ratio

ratio - ratio

getExpandRatio

public float getExpandRatio(Component component)

Specified by:

getExpandRatio in interface SupportsExpandRatio

Parameters:

component - component for which returns ratio

Returns:

ratio for the component, 0.0f by default

dispose

public void dispose()

Disposes frame references.

Should be called when a frame is removed from UI.

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(java.lang.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 java.util.stream.Stream<Facet> getFacets()

Specified by:

getFacets in interface Frame

Returns:

stream of registered non-visual components