com.haulmont.cuba.gui.components.actions

Class RelatedAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

com.haulmont.cuba.gui.components.actions.RelatedAction

All Implemented Interfaces:

HasBeforeActionPerformedHandler, io.jmix.ui.action.Action, io.jmix.ui.action.Action.HasPrimaryState, io.jmix.ui.action.Action.HasTarget, io.jmix.ui.action.Action.SecuredAction

@Component(value="cuba_RelatedAction")
 @Scope(value="prototype")
public class RelatedAction
extends io.jmix.ui.action.ListAction
implements HasBeforeActionPerformedHandler

Action used in RelatedEntities visual component.

In order to provide your own implementation globally, create a subclass and register it in web-spring.xml, for example:

 <bean id="cuba_RelatedAction" class="com.company.sample.gui.MyRelatedAction" scope="prototype"/>
 

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

io.jmix.ui.action.BaseAction.EnabledRule

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

HasBeforeActionPerformedHandler.BeforeActionPerformedHandler

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

io.jmix.ui.action.Action.ActionPerformedEvent, io.jmix.ui.action.Action.AdjustWhenScreenReadOnly, io.jmix.ui.action.Action.ExecutableAction, io.jmix.ui.action.Action.HasPrimaryState, io.jmix.ui.action.Action.HasSecurityConstraint, io.jmix.ui.action.Action.HasTarget, io.jmix.ui.action.Action.MainTabSheetAction, io.jmix.ui.action.Action.ScreenOpeningAction, io.jmix.ui.action.Action.SecuredAction, io.jmix.ui.action.Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID
protected HasBeforeActionPerformedHandler.BeforeActionPerformedHandler	beforeActionPerformedHandler
protected java.lang.String	filterCaption
protected io.jmix.core.metamodel.model.MetaClass	metaClass
protected io.jmix.core.metamodel.model.MetaProperty	metaProperty
protected WindowManager.OpenType	openType
protected RelatedEntitiesAPI	relatedEntitiesApi
protected java.lang.String	screen

Fields inherited from class io.jmix.ui.action.ListAction

target

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
RelatedAction(java.lang.String id, io.jmix.ui.component.ListComponent target, io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.metamodel.model.MetaProperty metaProperty)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(io.jmix.ui.component.Component component)
static RelatedAction	create(java.lang.String id, io.jmix.ui.component.ListComponent target, io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.metamodel.model.MetaProperty metaProperty) Creates an action with the given id.
HasBeforeActionPerformedHandler.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
void	setBeforeActionPerformedHandler(HasBeforeActionPerformedHandler.BeforeActionPerformedHandler handler) Sets handler that is invoked before the action is executed.
void	setFilterCaption(java.lang.String filterCaption)
protected void	setMessageTools(io.jmix.core.MessageTools messageTools)
void	setOpenType(WindowManager.OpenType openType)
void	setRelatedEntitiesApi(RelatedEntitiesAPI relatedEntitiesApi)
void	setScreen(java.lang.String screen)

Methods inherited from class io.jmix.ui.action.ListAction

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

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.action.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

See Also:

Constant Field Values

metaProperty

protected final io.jmix.core.metamodel.model.MetaProperty metaProperty

metaClass

protected final io.jmix.core.metamodel.model.MetaClass metaClass

screen

protected java.lang.String screen

filterCaption

protected java.lang.String filterCaption

openType

protected WindowManager.OpenType openType

relatedEntitiesApi

protected RelatedEntitiesAPI relatedEntitiesApi

beforeActionPerformedHandler

protected HasBeforeActionPerformedHandler.BeforeActionPerformedHandler beforeActionPerformedHandler

Constructor Detail

RelatedAction

public RelatedAction(java.lang.String id,
                     io.jmix.ui.component.ListComponent target,
                     io.jmix.core.metamodel.model.MetaClass metaClass,
                     io.jmix.core.metamodel.model.MetaProperty metaProperty)

Method Detail

create

public static RelatedAction create(java.lang.String id,
                                   io.jmix.ui.component.ListComponent target,
                                   io.jmix.core.metamodel.model.MetaClass metaClass,
                                   io.jmix.core.metamodel.model.MetaProperty metaProperty)

Creates an action with the given id.

Parameters:

target - component containing this action

setMessageTools

@Autowired
protected void setMessageTools(io.jmix.core.MessageTools messageTools)

setRelatedEntitiesApi

@Autowired
public void setRelatedEntitiesApi(RelatedEntitiesAPI relatedEntitiesApi)

setScreen

public void setScreen(java.lang.String screen)

setFilterCaption

public void setFilterCaption(java.lang.String filterCaption)

setOpenType

public void setOpenType(WindowManager.OpenType openType)

actionPerform

public void actionPerform(io.jmix.ui.component.Component component)

Specified by:

actionPerform in interface io.jmix.ui.action.Action

Overrides:

actionPerform in class io.jmix.ui.action.BaseAction

getBeforeActionPerformedHandler

public HasBeforeActionPerformedHandler.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface HasBeforeActionPerformedHandler

Returns:

before action performed handler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(HasBeforeActionPerformedHandler.BeforeActionPerformedHandler handler)

Description copied from interface: HasBeforeActionPerformedHandler

Sets handler that is invoked before the action is executed.

Specified by:

setBeforeActionPerformedHandler in interface HasBeforeActionPerformedHandler

Parameters:

handler - handler to set