Class MetaController

java.lang.Object

org.openxava.util.meta.MetaElement

org.openxava.controller.meta.MetaController

All Implemented Interfaces:

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(String parentName, String excludedActions)
boolean	containsMetaAction(String actionName)
Collection	getAllMetaActions()	The MetaActions of this controller and all its parents.
Collection<MetaControllerElement>	getAllMetaControllerElements()
Collection	getAllNotHiddenMetaActions()	The not hidden MetaActions of this controller and all its parents.
Collection	getAllNotHiddenMetaActionsRecursive()	The not hidden MetaActions of this controller and all its parents and subcontrollers recursively.
String	getClassName()	Only for spanish/swing version
String	getIcon()
String	getId()	Unique id of element, normally used to search the label in the resources files.
String	getImage()
MetaAction	getMetaAction(String name)
Collection	getMetaActions()
Collection	getMetaActionsAfterEachRequest()	Actions from father and subcontrollers are included.
Collection	getMetaActionsBeforeEachRequest()	Actions from father and subcontrollers are included.
Collection	getMetaActionsOnEachRequest()	Actions from father and subcontrollers are included.
Collection	getMetaActionsOnInit()	Actions from father and subcontrollers are included.
Collection<MetaControllerElement>	getMetaControllerElements()
Collection<MetaSubcontroller>	getMetaSubcontrollers()
Collection<MetaController>	getParents()
boolean	hasParents()
void	setClassName(String className)	Only for spanish/swing version
void	setIcon(String icon)
void	setImage(String image)

Methods inherited from class MetaElement

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

Methods inherited from class Object

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

Constructor Details

MetaController

public MetaController()

Method Details

addMetaControllerElement

public void addMetaControllerElement(MetaControllerElement controllerElement)

getMetaControllerElements

public Collection<MetaControllerElement> getMetaControllerElements()

getAllMetaControllerElements

public Collection<MetaControllerElement> getAllMetaControllerElements()

getClassName

public String getClassName()

Only for spanish/swing version

setClassName

public void setClassName(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(String parentName,
 String excludedActions)

getMetaAction

public MetaAction getMetaAction(String name)
                         throws ElementNotFoundException

Throws:

ElementNotFoundException

getMetaActions

public Collection getMetaActions()

Returns:

Not null, of type MetaAction and read only.

getMetaSubcontrollers

public Collection<MetaSubcontroller> getMetaSubcontrollers()

Since:

4.8

containsMetaAction

public boolean containsMetaAction(String actionName)

getAllMetaActions

public Collection getAllMetaActions()
                             throws XavaException

The MetaActions of this controller and all its parents.

Throws:

XavaException

getAllNotHiddenMetaActions

public Collection getAllNotHiddenMetaActions()
                                      throws XavaException

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

Throws:

XavaException

getAllNotHiddenMetaActionsRecursive

public 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 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 Collection getMetaActionsOnInit()
                                throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

hasParents

public boolean hasParents()

getParents

public Collection<MetaController> getParents()
                                      throws XavaException

Returns:

of type MetaController

Throws:

XavaException

getMetaActionsOnEachRequest

public Collection getMetaActionsOnEachRequest()
                                       throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getMetaActionsAfterEachRequest

public Collection getMetaActionsAfterEachRequest()
                                          throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getMetaActionsBeforeEachRequest

public Collection getMetaActionsBeforeEachRequest()
                                           throws XavaException

Actions from father and subcontrollers are included.

Throws:

XavaException

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

getImage

public String getImage()

setImage

public void setImage(String image)