com.haulmont.cuba.gui.components.actions

Class RelatedAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

com.haulmont.cuba.gui.components.actions.ListAction

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

All Implemented Interfaces:

Action, Action.HasBeforeActionPerformedHandler, Action.HasTarget, Action.SecuredAction

@Component(value="cuba_RelatedAction")
 @Scope(value="prototype")
public class RelatedAction
extends ListAction
implements Action.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 com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

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

Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID
protected Action.BeforeActionPerformedHandler	beforeActionPerformedHandler
protected java.lang.String	filterCaption
protected MetaClass	metaClass
protected MetaProperty	metaProperty
protected WindowManager.OpenType	openType
protected RelatedEntitiesAPI	relatedEntitiesApi
protected java.lang.String	screen

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

Fields inherited from class com.haulmont.cuba.gui.components.AbstractAction

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

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

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
RelatedAction(java.lang.String id, ListComponent target, MetaClass metaClass, MetaProperty metaProperty)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
static RelatedAction	create(java.lang.String id, ListComponent target, MetaClass metaClass, MetaProperty metaProperty) Creates an action with the given id.
Action.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
void	setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)
void	setFilterCaption(java.lang.String filterCaption)
protected void	setMessageTools(MessageTools messageTools)
void	setOpenType(WindowManager.OpenType openType)
void	setScreen(java.lang.String screen)

Methods inherited from class com.haulmont.cuba.gui.components.actions.ListAction

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

Methods inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

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

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDefaultCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, 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 com.haulmont.cuba.gui.components.Action

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

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

See Also:

Constant Field Values

metaProperty

protected final MetaProperty metaProperty

metaClass

protected final MetaClass metaClass

screen

protected java.lang.String screen

filterCaption

protected java.lang.String filterCaption

openType

protected WindowManager.OpenType openType

relatedEntitiesApi

@Inject
protected RelatedEntitiesAPI relatedEntitiesApi

beforeActionPerformedHandler

protected Action.BeforeActionPerformedHandler beforeActionPerformedHandler

Constructor Detail

RelatedAction

public RelatedAction(java.lang.String id,
                     ListComponent target,
                     MetaClass metaClass,
                     MetaProperty metaProperty)

Method Detail

create

public static RelatedAction create(java.lang.String id,
                                   ListComponent target,
                                   MetaClass metaClass,
                                   MetaProperty metaProperty)

Creates an action with the given id.

Parameters:

target - component containing this action

setMessageTools

@Inject
protected void setMessageTools(MessageTools messageTools)

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(Component component)

Description copied from interface: Action

Invoked by owning component when an action occurs.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

getBeforeActionPerformedHandler

public Action.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(Action.BeforeActionPerformedHandler handler)

Specified by:

setBeforeActionPerformedHandler in interface Action.HasBeforeActionPerformedHandler