Package org.openxava.controller.meta

Class MetaController

java.lang.Object

org.openxava.util.meta.MetaElement

org.openxava.controller.meta.MetaController

All Implemented Interfaces:

java.io.Serializable

public class MetaController
extends MetaElement

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaController()

Method Summary

Modifier and Type	Method	Description
void	addMetaAction(MetaAction action)
void	addMetaControllerElement(MetaControllerElement controllerElement)
void	addMetaSubcontroller(MetaSubcontroller subcontroller)
void	addParent(java.lang.String parentName, java.lang.String excludedActions)
boolean	containsMetaAction(java.lang.String actionName)
java.util.Collection	getAllMetaActions()	The MetaActions of this controller and all its parents.
java.util.Collection<MetaControllerElement>	getAllMetaControllerElements()
java.util.Collection	getAllNotHiddenMetaActions()	The not hidden MetaActions of this controller and all its parents.
java.util.Collection	getAllNotHiddenMetaActionsRecursive()	The not hidden MetaActions of this controller and all its parents and subcontrollers recursively.
java.lang.String	getClassName()	Only for spanish/swing version
java.lang.String	getIcon()
java.lang.String	getId()	Unique id of element, normally used to search the label in the resources files.
java.lang.String	getImage()
MetaAction	getMetaAction(java.lang.String name)
java.util.Collection	getMetaActions()
java.util.Collection	getMetaActionsAfterEachRequest()	Actions from father and subcontrollers are included.
java.util.Collection	getMetaActionsBeforeEachRequest()	Actions from father and subcontrollers are included.
java.util.Collection	getMetaActionsOnEachRequest()	Actions from father and subcontrollers are included.
java.util.Collection	getMetaActionsOnInit()	Actions from father and subcontrollers are included.
java.util.Collection<MetaControllerElement>	getMetaControllerElements()
java.util.Collection<MetaSubcontroller>	getMetaSubcontrollers()
java.util.Collection<MetaController>	getParents()
boolean	hasParents()
void	setClassName(java.lang.String className)	Only for spanish/swing version
void	setIcon(java.lang.String icon)
void	setImage(java.lang.String image)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaController

public MetaController()

Method Detail

addMetaControllerElement

public void addMetaControllerElement(MetaControllerElement controllerElement)

getMetaControllerElements

public java.util.Collection<MetaControllerElement> getMetaControllerElements()

getAllMetaControllerElements

public java.util.Collection<MetaControllerElement> getAllMetaControllerElements()

getClassName

public java.lang.String getClassName()

Only for spanish/swing version

setClassName

public void setClassName(java.lang.String className)

Only for spanish/swing version

addMetaSubcontroller

public void addMetaSubcontroller(MetaSubcontroller subcontroller)

Since:

4.8

addMetaAction

public void addMetaAction(MetaAction action)

addParent

public void addParent(java.lang.String parentName,
                      java.lang.String excludedActions)

getMetaAction

public MetaAction getMetaAction(java.lang.String name)
                         throws ElementNotFoundException

Throws:

ElementNotFoundException

getMetaActions

public java.util.Collection getMetaActions()

Returns:

Not null, of type MetaAction and read only.

getMetaSubcontrollers

public java.util.Collection<MetaSubcontroller> getMetaSubcontrollers()

Since:

4.8

containsMetaAction

public boolean containsMetaAction(java.lang.String actionName)

getAllMetaActions

public java.util.Collection getAllMetaActions()
                                       throws XavaException

The MetaActions of this controller and all its parents.

Throws:

XavaException

getAllNotHiddenMetaActions

public java.util.Collection getAllNotHiddenMetaActions()
                                                throws XavaException

The not hidden MetaActions of this controller and all its parents.

Throws:

XavaException

getAllNotHiddenMetaActionsRecursive

public java.util.Collection getAllNotHiddenMetaActionsRecursive()
                                                         throws XavaException

The not hidden MetaActions of this controller and all its parents and subcontrollers recursively.

Throws:

XavaException

Since:

5.5.1

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 MetaElement

getMetaActionsOnInit

public java.util.Collection getMetaActionsOnInit()
                                          throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

hasParents

public boolean hasParents()

getParents

public java.util.Collection<MetaController> getParents()
                                                throws XavaException

Returns:

of type MetaController

Throws:

XavaException

getMetaActionsOnEachRequest

public java.util.Collection getMetaActionsOnEachRequest()
                                                 throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getMetaActionsAfterEachRequest

public java.util.Collection getMetaActionsAfterEachRequest()
                                                    throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getMetaActionsBeforeEachRequest

public java.util.Collection getMetaActionsBeforeEachRequest()
                                                     throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)

getImage

public java.lang.String getImage()

setImage

public void setImage(java.lang.String image)