Package ch.tocco.nice2.model.menu.api

Class AbstractMenuItemReader<T extends MenuItem>

java.lang.Object

ch.tocco.nice2.model.menu.api.AbstractMenuItemReader<T>

Direct Known Subclasses:

ActionMenuReader, AdminMenuReader, EntityExplorerReader, FlowReader

public abstract class AbstractMenuItemReader<T extends MenuItem>
extends Object

Abstract implementation for every menu item reader. If you are interested in adding a new kind of menu items, please look in the wiki. It is described there.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alwaysShowOldClient
protected ItemReaderContext	ctx
protected DisplayValueFactory	displayValueFactory
protected String	extIcon
protected ItemFactory	itemFactory
protected DisplayValue	label
protected MenuItemLabelFactory	labelFactory
protected T	menuItem
protected String	menuType
protected String	name
protected boolean	newClientDisabled
protected boolean	oldClientDisabled
protected int	position
protected String	reactIcon
protected AdminMenuReceiver	receiver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMenuItemReader(String menuType, MenuItemLabelFactory labelFactory, ItemFactory itemFactory, DisplayValueFactory displayValueFactory, AdminMenuReceiver receiver)

Method Summary

Modifier and Type	Method	Description
protected void	afterFinish()
protected void	beforeFinish()
void	finished()	Called when the element is finished when item already exists
protected abstract T	getImpl()
protected abstract Class<T>	getInterface()
void	setAlwaysShowOldClient(boolean alwaysShowOldClient)
void	setExtIcon(String extIcon)
void	setName(String name)
void	setNewClientDisabled(boolean disabled)
void	setOldClientDisabled(boolean disabled)
void	setPosition(int position)
void	setReactIcon(String reactIcon)
Object	tag(String tagName)	Because we don't know what our children are, we just handle any sub-element and ask the ItemFactory bzw.

Methods inherited from class java.lang.Object

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

Field Details

receiver

protected AdminMenuReceiver receiver

displayValueFactory

protected DisplayValueFactory displayValueFactory

itemFactory

protected ItemFactory itemFactory

labelFactory

protected MenuItemLabelFactory labelFactory

menuItem

protected T extends MenuItem menuItem

ctx

protected ItemReaderContext ctx

menuType

protected String menuType

name

protected String name

label

protected DisplayValue label

extIcon

protected String extIcon

reactIcon

protected String reactIcon

position

protected int position

oldClientDisabled

protected boolean oldClientDisabled

newClientDisabled

protected boolean newClientDisabled

alwaysShowOldClient

protected boolean alwaysShowOldClient

Constructor Details

AbstractMenuItemReader

protected AbstractMenuItemReader(String menuType,
 MenuItemLabelFactory labelFactory,
 ItemFactory itemFactory,
 DisplayValueFactory displayValueFactory,
 AdminMenuReceiver receiver)

Method Details

setName

@Attribute("name")
@Required(true)
public void setName(String name)

setPosition

@Attribute("position")
public void setPosition(int position)

setExtIcon

@Attribute("ext-icon")
public void setExtIcon(String extIcon)

setReactIcon

@Attribute("react-icon")
public void setReactIcon(String reactIcon)

setOldClientDisabled

@Attribute("disable-old-client")
public void setOldClientDisabled(boolean disabled)

setNewClientDisabled

@Attribute("disable-new-client")
public void setNewClientDisabled(boolean disabled)

setAlwaysShowOldClient

@Attribute("always-show-old-client")
public void setAlwaysShowOldClient(boolean alwaysShowOldClient)

tag

@AnyElement
@Cardinality(min=0,
             max=2147483647)
public Object tag(@ElementName
 String tagName)
           throws ModelBuildException

Because we don't know what our children are, we just handle any sub-element and ask the ItemFactory bzw. the ItemReaderContext for the reader.

Parameters:

tagName - the sub-tag

Returns:

a reader for this tag if found in any case

Throws:

ModelBuildException

getImpl

protected abstract T getImpl()

getInterface

protected abstract Class<T> getInterface()

finished

@EndElement
public void finished()
              throws ModelBuildException

Called when the element is finished when item already exists

Throws:

ModelBuildException

beforeFinish

protected void beforeFinish()
                     throws ModelBuildException

Throws:

ModelBuildException

afterFinish

protected void afterFinish()
                    throws ModelBuildException

Throws:

ModelBuildException