Package com.simplicite.util
Class MenuItem
- java.lang.Object
-
- com.simplicite.util.MenuItem
-
- All Implemented Interfaces:
java.io.Serializable
public class MenuItem extends java.lang.Object implements java.io.Serializable
Main menu item- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MenuItem.State
State item
-
Field Summary
Fields Modifier and Type Field Description static char
ITEM_DOMAIN
Domain itemstatic char
ITEM_EXTERN
External itemstatic char
ITEM_OBJECT
Object itemstatic char
ITEM_PROCESS
Process itemstatic char
ITEM_WORKFLOW
Workflow item
-
Constructor Summary
Constructors Constructor Description MenuItem(char type, Domain domain, java.lang.String object, java.lang.String url, char menuSearch, boolean hist, java.lang.String icon, boolean ext)
Constructor of leaf item (object, extern, process, workflow)MenuItem(Domain domain)
Constructor of domain itemMenuItem(MenuItem item)
Copy constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAccessibleState(java.lang.String code, java.lang.String lang, java.lang.String value, java.lang.String icon, java.lang.String color, java.lang.String bgcolor)
Add a state to menu itemvoid
addChild(MenuItem child)
Add a child item to parent menuvoid
clear()
Clear sub-itemsjava.util.List<MenuItem>
findChildren(java.lang.String domain)
Deep search in a domainjava.util.List<MenuItem.State>
getAccessibleStates()
Accessible state codes of the state modeljava.util.List<MenuItem>
getChildren()
Get domain childrenDomain
getDomain()
Domainjava.lang.String
getDomainDisplay(java.lang.String lang)
Domain displayjava.lang.String
getDomainIcon()
Domain iconjava.lang.String
getDomainId()
Domain idjava.lang.String
getHomePageName()
Domain home page (view name)java.lang.String
getItemIcon()
Item iconjava.lang.String
getObjectDisplay(java.lang.String lang)
Item displayjava.lang.String
getObjectName()
ObjectMenuItem
getParent()
Get parent itemchar
getSearchMode()
Default search modejava.lang.String
getStateModelField()
State modelchar
getType()
Item typejava.lang.String
getURL(Grant g)
Get the external URLboolean
hasHistoric()
Has historic object ?boolean
hasHomePage()
Has home page ?boolean
isDomain()
Is domain ?boolean
isDomainOpen()
Is domain opened ? (legacy)boolean
isExtended()
Extended menu ?boolean
isExtern()
Is external object ?boolean
isObject()
Is object ?boolean
isObjectOpen()
Is object opened ? (legacy)boolean
isProcess()
Is process (multi-users)boolean
isWorkflow()
Is workflow (mono-user)void
load(Grant g, MenuItem item)
Load the user's menuboolean
noSearchForm()
No search formvoid
setAccessibleStates(java.util.List<MenuItem.State> states)
Set accessible statesvoid
setDisplay(java.lang.String lang, java.lang.String value)
Set item labelvoid
setDomainOpen(boolean b)
Set domain open (legacy)void
setExtended(boolean ext)
Set the extended flagvoid
setObjectOpen(boolean b)
Set object open (legacy)void
setSearchMode(char mode)
Set the search modevoid
setStateModel(java.lang.String field)
Set status field
-
-
-
Field Detail
-
ITEM_DOMAIN
public static final char ITEM_DOMAIN
Domain item- See Also:
- Constant Field Values
-
ITEM_OBJECT
public static final char ITEM_OBJECT
Object item- See Also:
- Constant Field Values
-
ITEM_EXTERN
public static final char ITEM_EXTERN
External item- See Also:
- Constant Field Values
-
ITEM_PROCESS
public static final char ITEM_PROCESS
Process item- See Also:
- Constant Field Values
-
ITEM_WORKFLOW
public static final char ITEM_WORKFLOW
Workflow item- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MenuItem
public MenuItem(char type, Domain domain, java.lang.String object, java.lang.String url, char menuSearch, boolean hist, java.lang.String icon, boolean ext)
Constructor of leaf item (object, extern, process, workflow)- Parameters:
type
- ITEM_*domain
- Domain definitionobject
- Optional object nameurl
- Optional URLmenuSearch
- Optional search typehist
- Has history?icon
- Optional item iconext
- Extended item
-
MenuItem
public MenuItem(Domain domain)
Constructor of domain item- Parameters:
domain
- Domain container
-
MenuItem
public MenuItem(MenuItem item)
Copy constructor- Parameters:
item
- Item to clone
-
-
Method Detail
-
clear
public void clear()
Clear sub-items
-
load
public void load(Grant g, MenuItem item)
Load the user's menu- Parameters:
g
- User rightsitem
- Target item to load
-
findChildren
public java.util.List<MenuItem> findChildren(java.lang.String domain)
Deep search in a domain- Parameters:
domain
- Domain name- Returns:
- List of children including sub-domains
-
getType
public char getType()
Item type- Returns:
- One of ITEM_*
-
isDomain
public boolean isDomain()
Is domain ?- Returns:
- true if is domain
-
isObject
public boolean isObject()
Is object ?- Returns:
- true if is object
-
isExtern
public boolean isExtern()
Is external object ?- Returns:
- true if is external
-
isProcess
public boolean isProcess()
Is process (multi-users)- Returns:
- true if is a long process
-
isWorkflow
public boolean isWorkflow()
Is workflow (mono-user)- Returns:
- true if is a short process
-
getDomain
public Domain getDomain()
Domain- Returns:
- Domain
-
getDomainDisplay
public java.lang.String getDomainDisplay(java.lang.String lang)
Domain display- Parameters:
lang
- user language- Returns:
- Domain label
-
getDomainIcon
public java.lang.String getDomainIcon()
Domain icon- Returns:
- Domain icon
-
getDomainId
public java.lang.String getDomainId()
Domain id- Returns:
- Domain id
-
hasHomePage
public boolean hasHomePage()
Has home page ?- Returns:
- true if has home page
-
getHomePageName
public java.lang.String getHomePageName()
Domain home page (view name)- Returns:
- Home name if any
-
getObjectName
public java.lang.String getObjectName()
Object- Returns:
- Object name
-
getObjectDisplay
public java.lang.String getObjectDisplay(java.lang.String lang)
Item display- Returns:
- Item label
-
setDisplay
public void setDisplay(java.lang.String lang, java.lang.String value)
Set item label- Parameters:
lang
- User languagevalue
- Value to display
-
isExtended
public boolean isExtended()
Extended menu ?- Returns:
- true if item is extended
-
setExtended
public void setExtended(boolean ext)
Set the extended flag- Parameters:
ext
- item is extended?
-
getItemIcon
public java.lang.String getItemIcon()
Item icon- Returns:
- Icon name if any
-
getURL
public java.lang.String getURL(Grant g)
Get the external URL- Parameters:
g
- User rights- Returns:
- Parsed URL
-
noSearchForm
public boolean noSearchForm()
No search form- Returns:
- True if search mode is "hide"
-
getSearchMode
public char getSearchMode()
Default search mode- Returns:
- Search mode SEARCH_*
-
setSearchMode
public void setSearchMode(char mode)
Set the search mode- Parameters:
mode
- SEARCH_*
-
hasHistoric
public boolean hasHistoric()
Has historic object ?- Returns:
- true if has a history
-
isDomainOpen
public boolean isDomainOpen()
Is domain opened ? (legacy)- Returns:
- true if opened
-
setDomainOpen
public void setDomainOpen(boolean b)
Set domain open (legacy)- Parameters:
b
- opened?
-
isObjectOpen
public boolean isObjectOpen()
Is object opened ? (legacy)- Returns:
- true if opened
-
setObjectOpen
public void setObjectOpen(boolean b)
Set object open (legacy)- Parameters:
b
- opened?
-
getStateModelField
public java.lang.String getStateModelField()
State model- Returns:
- Status field name
-
setStateModel
public void setStateModel(java.lang.String field)
Set status field- Parameters:
field
- Field name
-
getAccessibleStates
public java.util.List<MenuItem.State> getAccessibleStates()
Accessible state codes of the state model- Returns:
- list of states
-
setAccessibleStates
public void setAccessibleStates(java.util.List<MenuItem.State> states)
Set accessible states- Parameters:
states
- list of states
-
addAccessibleState
public void addAccessibleState(java.lang.String code, java.lang.String lang, java.lang.String value, java.lang.String icon, java.lang.String color, java.lang.String bgcolor)
Add a state to menu item- Parameters:
code
- Enum codelang
- Languagevalue
- Translated valueicon
- Optional iconcolor
- Optional text colorbgcolor
- Optional background color
-
getChildren
public java.util.List<MenuItem> getChildren()
Get domain children- Returns:
- list or null
-
getParent
public MenuItem getParent()
Get parent item- Returns:
- Item or null
-
addChild
public void addChild(MenuItem child)
Add a child item to parent menu- Parameters:
child
- Item
-
-