public abstract class OwMenu extends OwNavigationView
Base class for menus for the Workdesk.
The Menu Items can consist of Icons or Text or both.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Class and Description |
---|---|
class |
OwMenu.OwMenuTab
a navigation item
|
OwNavigationView.OwAbstractTabInfo, OwNavigationView.OwDelimiterTabInfo, OwNavigationView.OwTabInfo
Modifier and Type | Field and Description |
---|---|
protected int |
defaultButtonIndex
the default button index
|
protected static int |
NO_DEFAULT_BUTTON
constant for situation when no default button was considered for this menu
|
m_fValidatePanels, m_iCurrentTabIndex, m_TabList
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwMenu() |
Modifier and Type | Method and Description |
---|---|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p,
boolean validateForm)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p,
boolean validateForm)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p,
String strFormName_p)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p,
String strFormName_p,
boolean validateForm)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p,
String strFormName_p)
add a menu Item to the navigation module.
|
int |
addFormMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p,
String strFormName_p,
boolean validateForm)
add a menu Item to the navigation module.
|
int |
addMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p)
add a menu Item to the navigation module.
|
int |
addMenuItem(OwEventTarget target_p,
String strTitle_p,
String strEvent_p,
String strToolTip_p,
boolean validateForm)
add a menu Item to the navigation module.
|
int |
addMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p)
add a menu Item to the navigation module.
|
int |
addMenuItem(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
String strEvent_p,
Object oReason_p,
String strToolTip_p,
boolean validateForm)
add a menu Item to the navigation module.
|
void |
check(boolean fEnable_p,
int iIndex_p)
display a checkbox
|
protected OwMenu.OwMenuTab |
createTabInfo(OwEventTarget target_p,
String strTitle_p,
String strImage_p,
Object oReason_p,
String strEvent_p,
String strToolTip_p)
overridable to create a tab info
|
protected Object |
getImage(int iIndex_p)
get the user object of the menu item
|
String |
getMenuEventURL()
Method to be called from renderer,
which is called if there is a default button defined.
|
boolean |
isChecked(int iIndex_p)
determine if the button is checked via check function
|
protected void |
onRender(Writer w_p)
Add code for register menu event to ENTER keyboard event.
|
void |
setDefaultMenuItem(int defaultMenuItemIndex_p)
Specify what index from existing entries should be considered as default for ENTER key at a specific moment.
|
protected void |
setFormSubmitButton(String strFormName_p,
int iButtonIndex_p)
specify a button in the navigation view to act as a form submit button
|
void |
setImage(String strImage_p,
int iIndex_p)
change the user object of the menu item
|
void |
toggleCheck(int iIndex_p)
toggle the checked state
|
addDelimiter, addMenuItem, addView, clear, enable, enableAll, getNavigateEventURL, getNavigationFormAction, getNavigationIndex, getTab, getTabList, getTitle, getViewReference, isLastTabIndex, isPreviousPanelValid, navigate, navigate, navigate, navigateFirst, onFormEvent, onNavigate, registerView, renderCurrentView, renderNavigationLink, setValidatePanels, setVisible, size
activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, init, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onRequest, updateExternalFormTarget
protected static final int NO_DEFAULT_BUTTON
protected int defaultButtonIndex
public boolean isChecked(int iIndex_p)
public void check(boolean fEnable_p, int iIndex_p) throws Exception
fEnable_p
- true = check the box, false = uncheckiIndex_p
- button indexException
public void toggleCheck(int iIndex_p) throws Exception
Exception
protected void setFormSubmitButton(String strFormName_p, int iButtonIndex_p) throws Exception
strFormName_p
- Name of the form where the button is usediButtonIndex_p
- Index of the menu button to act as submit buttonException
public void setImage(String strImage_p, int iIndex_p)
strImage_p
- imageiIndex_p
- int index of the item to set the object forprotected Object getImage(int iIndex_p)
iIndex_p
- int index of the item to set the object forpublic int addMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textException
public int addMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textvalidateForm
- booleanException
public int addMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional ImagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textException
public int addMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional ImagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textvalidateForm
- boolean control Form validationException
protected OwMenu.OwMenuTab createTabInfo(OwEventTarget target_p, String strTitle_p, String strImage_p, Object oReason_p, String strEvent_p, String strToolTip_p)
target_p
- strTitle_p
- strImage_p
- oReason_p
- strEvent_p
- strToolTip_p
- public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p, String strFormName_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textstrFormName_p
- Form NameException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p, String strFormName_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textstrFormName_p
- Form NamevalidateForm
- booleanException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strEvent_p, String strToolTip_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrEvent_p
- name of the event method to be called in the event target.strToolTip_p
- Tooltip textvalidateForm
- booleanException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p, String strFormName_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional imagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textstrFormName_p
- Form NameException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p, String strFormName_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional imagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textstrFormName_p
- Form NamevalidateForm
- booleanException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional imagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textException
public int addFormMenuItem(OwEventTarget target_p, String strTitle_p, String strImage_p, String strEvent_p, Object oReason_p, String strToolTip_p, boolean validateForm) throws Exception
target_p
- View to be notified in case menu item was pressed.strTitle_p
- name of the tab to be displayedstrImage_p
- optional imagestrEvent_p
- name of the event method to be called in the event target.oReason_p
- optional object to be submitted to the event handler. Can be null.strToolTip_p
- Tooltip textvalidateForm
- booleanException
public void setDefaultMenuItem(int defaultMenuItemIndex_p)
defaultMenuItemIndex_p
- - the indexprotected void onRender(Writer w_p) throws Exception
onRender
in class OwNavigationView
w_p
- Writer object to write HTML toException
OwNavigationView.onRender(java.io.Writer)
public String getMenuEventURL()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.