Package org.openxava.controller.meta

Class MetaAction

java.lang.Object

org.openxava.util.meta.MetaElement

org.openxava.controller.meta.MetaControllerElement

org.openxava.controller.meta.MetaAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MetaAction
extends MetaControllerElement
implements java.lang.Cloneable

Author:

Javier Paniza

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALMOST_ALWAYS
static int	ALMOST_NEVER
static int	ALWAYS
static int	IF_POSSIBLE
static int	NEVER

Constructor Summary

Constructors

Constructor	Description
MetaAction()
MetaAction(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	_addMetaSet(MetaSet metaSet)
void	addMetaUseObject(MetaUseObject object)
MetaAction	cloneMetaAction()
IAction	createAction()
boolean	equals(java.lang.Object action)
int	getByDefault()
java.lang.String	getClassName()
java.lang.String	getConfirmMessage()
java.lang.String	getConfirmMessage(java.util.Locale locale, java.lang.String... argv)
java.lang.String	getConfirmMessage(javax.servlet.ServletRequest request)
java.lang.String	getConfirmMessage(javax.servlet.ServletRequest request, java.lang.String argv)
java.lang.String	getControllerName()
java.lang.String	getId()	Unique id of element, normally used to search the label in the resources files.
java.lang.String	getKeystroke()
java.lang.String	getLabel(java.util.Locale locale)	For refine the label calculation
MetaController	getMetaController()
java.util.Collection	getMetaSets()
java.util.Collection	getMetaUseObjects()
java.lang.String	getMethod()
char	getMnemonic()
java.lang.String	getQualifiedName()
int	hashCode()
boolean	hasKeystroke()
boolean	hasMetaSets()
boolean	inNewWindow()
boolean	isAfterEachRequest()
boolean	isAvailableOnNew()
boolean	isBeforeEachRequest()
boolean	isConfirm()
boolean	isHidden()
boolean	isInEachRow()
boolean	isLosesChangedData()
boolean	isOnEachRequest()
boolean	isOnInit()
boolean	isProcessSelectedItems()
boolean	isTakesLong()
void	setAfterEachRequest(boolean afterEachRequest)
void	setAvailableOnNew(boolean availableOnNew)
void	setBeforeEachRequest(boolean beforeEachRequest)
void	setByDefault(int i)
void	setClassName(java.lang.String string)
void	setConfirm(boolean confirm)
void	setHidden(boolean b)
void	setInEachRow(boolean inEachRow)
void	setKeystroke(java.lang.String keystroke)
void	setLosesChangedData(boolean losesChangedData)
void	setMetaController(MetaController controller)
void	setMethod(java.lang.String method)
void	setName(java.lang.String newName)
void	setOnEachRequest(boolean b)
void	setOnInit(boolean b)
void	setProcessSelectedItems(boolean processSelectedItems)
void	setTakesLong(boolean takesLong)
java.lang.String	toString()
boolean	usesObjects()

Methods inherited from class org.openxava.controller.meta.MetaControllerElement

appliesToMode, getIcon, getImage, getMode, hasIcon, hasImage, setIcon, setImage, setMode

Methods inherited from class org.openxava.util.meta.MetaElement

getDescription, getDescription, getDescription, getDescription, getLabel, getLabel, getLabel, getLocale, getName, getPlaceholder, getPlaceholder, getPlaceholder, has18nLabel, hasName, setDescription, setLabel, setPlaceholder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NEVER

public static final int NEVER

See Also:

Constant Field Values

ALMOST_NEVER

public static final int ALMOST_NEVER

Since:

4m6

See Also:

Constant Field Values

IF_POSSIBLE

public static final int IF_POSSIBLE

See Also:

Constant Field Values

ALMOST_ALWAYS

public static final int ALMOST_ALWAYS

See Also:

Constant Field Values

ALWAYS

public static final int ALWAYS

See Also:

Constant Field Values

Constructor Detail

MetaAction

public MetaAction()

MetaAction

public MetaAction(java.lang.String name)

Method Detail

getQualifiedName

public java.lang.String getQualifiedName()

setName

public void setName(java.lang.String newName)

Overrides:

setName in class MetaElement

getKeystroke

public java.lang.String getKeystroke()

setKeystroke

public void setKeystroke(java.lang.String keystroke)

cloneMetaAction

public MetaAction cloneMetaAction()

hasKeystroke

public boolean hasKeystroke()

getMethod

public java.lang.String getMethod()

setMethod

public void setMethod(java.lang.String method)

getLabel

public java.lang.String getLabel(java.util.Locale locale)

Description copied from class: MetaElement

For refine the label calculation

Overrides:

getLabel in class MetaElement

getMnemonic

public char getMnemonic()

equals

public boolean equals(java.lang.Object action)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String string)

usesObjects

public boolean usesObjects()

getMetaUseObjects

public java.util.Collection getMetaUseObjects()

addMetaUseObject

public void addMetaUseObject(MetaUseObject object)

getMetaController

public MetaController getMetaController()

Specified by:

getMetaController in class MetaControllerElement

setMetaController

public void setMetaController(MetaController controller)

getControllerName

public java.lang.String getControllerName()

_addMetaSet

public void _addMetaSet(MetaSet metaSet)

createAction

public IAction createAction()
                     throws XavaException

Throws:

XavaException

hasMetaSets

public boolean hasMetaSets()

getMetaSets

public java.util.Collection getMetaSets()

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean b)

getByDefault

public int getByDefault()

setByDefault

public void setByDefault(int i)

getId

public java.lang.String getId()

Description copied from class: MetaElement

Unique id of element, normally used to search the label in the resources files.

Specified by:

getId in class MetaControllerElement

isOnInit

public boolean isOnInit()

setOnInit

public void setOnInit(boolean b)

isTakesLong

public boolean isTakesLong()

setTakesLong

public void setTakesLong(boolean takesLong)

isConfirm

public boolean isConfirm()

getConfirmMessage

public java.lang.String getConfirmMessage()

getConfirmMessage

public java.lang.String getConfirmMessage(java.util.Locale locale,
                                          java.lang.String... argv)

Parameters:

argv - Since 4m5

getConfirmMessage

public java.lang.String getConfirmMessage(javax.servlet.ServletRequest request,
                                          java.lang.String argv)

Since:

4m5

getConfirmMessage

public java.lang.String getConfirmMessage(javax.servlet.ServletRequest request)

setConfirm

public void setConfirm(boolean confirm)

isOnEachRequest

public boolean isOnEachRequest()

setOnEachRequest

public void setOnEachRequest(boolean b)

isBeforeEachRequest

public boolean isBeforeEachRequest()

setBeforeEachRequest

public void setBeforeEachRequest(boolean beforeEachRequest)

setInEachRow

public void setInEachRow(boolean inEachRow)

isInEachRow

public boolean isInEachRow()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isAfterEachRequest

public boolean isAfterEachRequest()

setAfterEachRequest

public void setAfterEachRequest(boolean afterEachRequest)

isProcessSelectedItems

public boolean isProcessSelectedItems()

setProcessSelectedItems

public void setProcessSelectedItems(boolean processSelectedItems)

inNewWindow

public boolean inNewWindow()

Since:

5.8

isAvailableOnNew

public boolean isAvailableOnNew()

setAvailableOnNew

public void setAvailableOnNew(boolean availableOnNew)

isLosesChangedData

public boolean isLosesChangedData()

Since:

6.3

setLosesChangedData

public void setLosesChangedData(boolean losesChangedData)

Since:

6.3