com.saperion.ngc.resultset.contextmenu

Class AbstractContextMenu

java.lang.Object

com.saperion.ngc.resultset.contextmenu.AbstractContextMenu

Direct Known Subclasses:

AbstractWorkflowContextMenu, EmptyContextMenu, MultiDocumentContextMenu, MultiFolderContextMenu, MultiLookupContextMenu, SingleDocumentContextMenu, SingleFolderContextMenu, SingleLookupContextMenu

public abstract class AbstractContextMenu
extends Object

Abstract superclass for all context menu types.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.saperion.ngc.iform.xml.ResultType	definition Parent's type definition.
protected LocalizationUtil	localization Localization utility.
protected ResultSetPresenter	presenter Parent view's presenter.
protected User	user Current user from session.
protected UserProfile	userProfile The profile of the current user.
protected ResultSetViewImpl	view Parent view.
protected ContextMenuVisibility	visibility Helper class that manages visibility of context menu items.

Constructor Summary

Constructors

Constructor and Description
AbstractContextMenu(ResultSetViewImpl view, ResultSetPresenter presenter, com.saperion.ngc.iform.xml.ResultType definition, ContextMenuVisibility visibility)

Method Summary

Modifier and Type	Method and Description
protected String	getCoreString(String key)
abstract List<org.zkoss.zk.ui.Component>	getMenuItems()
protected String	getString(String key)
protected boolean	isEfileQueryMask()
protected boolean	isIndexUser()
protected boolean	isLookupMode()

Methods inherited from class java.lang.Object

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

Field Detail

view

protected final ResultSetViewImpl view

Parent view.

presenter

protected final ResultSetPresenter presenter

Parent view's presenter.

localization

protected final LocalizationUtil localization

Localization utility.

definition

protected final com.saperion.ngc.iform.xml.ResultType definition

Parent's type definition.

user

protected final User user

Current user from session.

visibility

protected final ContextMenuVisibility visibility

Helper class that manages visibility of context menu items.

userProfile

protected final UserProfile userProfile

The profile of the current user.

Constructor Detail

AbstractContextMenu

public AbstractContextMenu(ResultSetViewImpl view,
                           ResultSetPresenter presenter,
                           com.saperion.ngc.iform.xml.ResultType definition,
                           ContextMenuVisibility visibility)

Parameters:

view - associated result set view instance

presenter - presenter of associated result set view instance

definition - result set type definition

visibility - visibility helper

Method Detail

getMenuItems

public abstract List<org.zkoss.zk.ui.Component> getMenuItems()
                                                      throws NgcUiException,
                                                             AuthenticationException

Returns:

list of menu items for the context menu

Throws:

NgcUiException - exception to be handled by view

AuthenticationException - re-logon required

getString

protected String getString(String key)

Parameters:

key - key to localize

Returns:

web-localized string

getCoreString

protected String getCoreString(String key)

Parameters:

key - key to localize

Returns:

core-localized string

isLookupMode

protected boolean isLookupMode()

Returns:

if view is in lookup-mode

isEfileQueryMask

protected boolean isEfileQueryMask()

Returns:

if parent view shows an eFile-query-mask

isIndexUser

protected boolean isIndexUser()

Returns:

if the current user is an index-user