Class CollectionBaseAction
- java.lang.Object
-
- org.openxava.actions.BaseAction
-
- org.openxava.actions.ViewBaseAction
-
- org.openxava.actions.CollectionElementViewBaseAction
-
- org.openxava.actions.CollectionBaseAction
-
- All Implemented Interfaces:
IAction
,IChangeModeAction
,IModuleContextAction
,IRequestAction
- Direct Known Subclasses:
CreateNewElementInManyToManyCollectionAction
,CutElementsFromCollectionAction
,DeleteSelectedInCollectionBaseAction
,MoveMyReportColumnAction
,OnSelectElementBaseAction
,RemoveMyReportColumnAction
,RemoveSelectedTreeViewNodeAction
public abstract class CollectionBaseAction extends CollectionElementViewBaseAction
Base class for creating actions to be used as list actions.That is in <list-action/> of <collection-view/> or in @ListAction annotation.
- Author:
- Javier Paniza
-
-
Field Summary
-
Fields inherited from interface org.openxava.actions.IChangeModeAction
DETAIL, LIST, PREVIOUS_MODE, SPLIT
-
-
Constructor Summary
Constructors Constructor Description CollectionBaseAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.List<java.util.Map>
getMapsSelectedValues()
A list of selected collection element when each element is a map with the values of the collection element.protected java.util.List<java.util.Map>
getMapValues()
A list of all collection element when each element is a map with the values of the collection element.protected java.util.List
getObjects()
A list of all objects (POJOs or EntityBeans) in the collection.int
getRow()
This property has value when the action has been clicked from the row.protected java.util.Map[]
getSelectedKeys()
Keys of the selected collection element.protected java.util.List
getSelectedObjects()
A list of selected objects (POJOs or EntityBeans) in the collection.void
setRow(int row)
-
Methods inherited from class org.openxava.actions.CollectionElementViewBaseAction
closeDialog, execute, getCollectionElementView, getMetaCollection, getParentView, getView, getViewObject, isCloseDialogDisallowed, isEntityReferencesCollection, isEntityReferencesCollection, mustRefreshCollection, 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
-
-
-
-
Method Detail
-
getMapValues
protected java.util.List<java.util.Map> getMapValues() throws XavaException
A list of all collection element when each element is a map with the values of the collection element.The values only include the displayed data in the row.
- Returns:
- Of type Map. Never null.
- Throws:
XavaException
-
getMapsSelectedValues
protected java.util.List<java.util.Map> getMapsSelectedValues() throws XavaException
A list of selected collection element when each element is a map with the values of the collection element.If
row
property has value it returns the resulting list will contain the value of that row only.
The values only include the displayed data in the row.- Returns:
- Of type Map. Never null.
- Throws:
XavaException
-
getSelectedKeys
protected java.util.Map[] getSelectedKeys() throws XavaException
Keys of the selected collection element.If
row
property has value it returns the resulting list will contain the value of that row only.
The result is a Map with the key of each selected row, with the exception of @ElementCollection that returns all the displayed values of each selected row.- Returns:
- Never null.
- Throws:
XavaException
- Since:
- 6.0.2
-
getObjects
protected java.util.List getObjects() throws java.rmi.RemoteException, javax.ejb.FinderException, XavaException
A list of all objects (POJOs or EntityBeans) in the collection.Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).
- Returns:
- Never null.
- Throws:
java.rmi.RemoteException
javax.ejb.FinderException
XavaException
-
getSelectedObjects
protected java.util.List getSelectedObjects() throws java.rmi.RemoteException, javax.ejb.FinderException, XavaException
A list of selected objects (POJOs or EntityBeans) in the collection.Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).
Ifrow
property has value it returns the resulting list will contain the object of that row only.- Returns:
- Never null.
- Throws:
java.rmi.RemoteException
javax.ejb.FinderException
XavaException
-
setRow
public void setRow(int row)
-
getRow
public int getRow()
This property has value when the action has been clicked from the row.If not its value is -1.
-
-