Package org.openxava.actions

Class OnSelectElementBaseAction

java.lang.Object

org.openxava.actions.BaseAction

org.openxava.actions.ViewBaseAction

org.openxava.actions.CollectionElementViewBaseAction

org.openxava.actions.CollectionBaseAction

org.openxava.actions.OnSelectElementBaseAction

All Implemented Interfaces:

IAction, IChangeModeAction, IModuleContextAction, IRequestAction

public abstract class OnSelectElementBaseAction
extends CollectionBaseAction

Base action for actions executed when a collection element is selected or unselected.

This type of action is defined using {link org.openxava.annotations.OnSelectElementAction} annotation, or its XML counterpart on-select-element-action.
This is a convenience class, if you want you can extend directly from {link CollectionBaseAction} and add the properties row and selected to your own action.

Author:

Javier Paniza

Field Summary

Fields inherited from interface org.openxava.actions.IChangeModeAction

DETAIL, LIST, PREVIOUS_MODE, SPLIT

Constructor Summary

Constructors

Constructor	Description
OnSelectElementBaseAction()

Method Summary

Modifier and Type	Method	Description
abstract void	execute()
int	getRow()	Row number of the selected or unselected element.
boolean	isSelected()	If the element has been selected or unselected.
protected boolean	mustRefreshCollection()
void	setRow(int row)
void	setSelected(boolean selected)

Methods inherited from class org.openxava.actions.CollectionBaseAction

getMapsSelectedValues, getMapValues, getObjects, getSelectedKeys, getSelectedObjects

Methods inherited from class org.openxava.actions.CollectionElementViewBaseAction

closeDialog, getCollectionElementView, getCollectionLabel, getMetaCollection, getMetaCollectionView, getParentView, getView, getViewObject, isCloseDialogDisallowed, isEntityReferencesCollection, isEntityReferencesCollection, setCloseDialogDisallowed, setViewObject, showDialog, validateMaximum, validateMinimum

Methods inherited from class org.openxava.actions.ViewBaseAction

changeThisPropertyByViewValue, getModelName, getPreviousView, getPreviousViews, resetDescriptionsCache, returnToPreviousView, setControllers, setPreviousViews, setView, showDialog, showNewView, showView, validateViewValues

Methods inherited from class org.openxava.actions.BaseAction

addActions, addError, addErrors, addInfo, addMessage, addMessages, addWarning, clearActions, commit, executeAction, executeAfter, executeBefore, getContext, getEnvironment, getErrors, getLocale, getManager, getMessages, getNextMode, getQualifiedActionIfAvailable, getRequest, removeActions, returnToPreviousControllers, rollback, setContext, setDefaultControllers, setEnvironment, setErrors, setMessages, setNextMode, setRequest

Methods inherited from class java.lang.Object

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

Constructor Details

OnSelectElementBaseAction

public OnSelectElementBaseAction()

Method Details

execute

public abstract void execute()
                      throws Exception

Specified by:

execute in interface IAction

Specified by:

execute in class CollectionElementViewBaseAction

Throws:

Exception

mustRefreshCollection

protected boolean mustRefreshCollection()

Overrides:

mustRefreshCollection in class CollectionElementViewBaseAction

getRow

public int getRow()

Row number of the selected or unselected element.

Overrides:

getRow in class CollectionBaseAction

setRow

public void setRow(int row)

Overrides:

setRow in class CollectionBaseAction

isSelected

public boolean isSelected()

If the element has been selected or unselected.

setSelected

public void setSelected(boolean selected)