Package io.jmix.ui.component

Interface ActionOwner

All Known Subinterfaces:

Button, LinkButton

All Known Implementing Classes:

ButtonImpl, LinkButtonImpl, PaletteButton

public interface ActionOwner

Component supporting an action.

Method Summary

Modifier and Type	Method	Description
Action	getAction()
default void	setAction(Action action)	Sets the action to the owner.
void	setAction(Action action, boolean overrideOwnerProperties)	Sets the action to the owner.

Method Details

getAction

@Nullable
Action getAction()

Returns:

an action or null

setAction

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.action.Action")
default void setAction(@Nullable
 Action action)

Sets the action to the owner. Action properties override owner properties.

List of properties that the action and the owner have and which can be overridden:

• caption
• description
• shortcut
• enabled
• visible
• primary
• icon

Parameters:

action - an action

setAction

void setAction(@Nullable
 Action action,
 boolean overrideOwnerProperties)

Sets the action to the owner. If overrideOwnerProperties is true then the action properties will override owner properties, otherwise the owner properties will be overridden if they are null.

List of properties that the action and the owner have and which can be overridden:

• caption
• description
• shortcut
• enabled
• visible
• primary
• icon

Parameters:

action - an action

overrideOwnerProperties - whether action properties override owner properties