MenuEntry (admin-tools core componenets 1.1.5 API)

java.lang.Object
- de.chandre.admintool.core.component.MenuEntry

All Implemented Interfaces:

Serializable
```
public class MenuEntry
extends Object
implements Serializable
```
Menu entry for left main menu
displayName is required on every item, name and target only if entry has no submenu

Since:

1.0.0

Author:

Andre

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`MenuEntry()`
`MenuEntry(String name, String displayName, String target)`
`MenuEntry(String name, String displayName, String target, Set<String> securityRoles)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalCSS(String additionalCSS, boolean relative)` path to CSS.
`void`	`addAdditionalJS(String additionalJS, boolean relative)` path to additional JavaScript files.
`void`	`addSecurityRole(String securityRole)`
`void`	`addSubmenuEntry(MenuEntry submenu)` add a sub menu entry
`void`	`addVariable(String key, Object variable)` add a additional variable for the template context e.g.: if you want to access a self created object within the template which is not accessible via Thymeleaf bean resolution.
`Stream<MenuEntry>`	`flattened()`
`Map<String,Boolean>`	`getAdditionalCSS()`
`Map<String,Boolean>`	`getAdditionalCSSReverse()` returns all additional js from this to upper menu item hierarchy beginning with the root.
`Map<String,Boolean>`	`getAdditionalJS()`
`Map<String,Boolean>`	`getAdditionalJSReverse()` returns all additional js from this to upper menu item hierarchy beginning with the root.
`Set<String>`	`getAffectedSecurityRoles()` the effective roles reverse recursive to component if not set at this object or anywhere within the tree first menu entry or component with roles will return it.
`String`	`getDisplayName()` display name shown in the menu
`String`	`getName()` the link mapping
`MenuEntry`	`getParent()` the parent entry or null if root
`String`	`getResouceMessageKey()` not implemented
`Set<String>`	`getSecurityRoles()`
`List<MenuEntry>`	`getSubmenu()` list of sub menu entries.
`String`	`getTarget()` relative path to target template
`Object`	`getVariable(String key)` returns the menu variable by key
`Map<String,Object>`	`getVariables()` returns the variables map
`boolean`	`isHide()` if set to true this menu entry will be hidden, but still requestable
`boolean`	`isUseCCSHierarchy()`
`boolean`	`isUseJSHierarchy()`
`Stream<MenuEntry>`	`reverseFlattened()`
`void`	`setAdditionalCSS(Map<String,Boolean> additionalCSS)` map with paths to CSS.
`void`	`setAdditionalJS(Map<String,Boolean> additionalJS)` map with path to additional JavaScript files.
`void`	`setDisplayName(String displayName)` display name shown in the menu
`void`	`setHide(boolean hide)` if set to true this menu entry will be hidden, but still requestable
`void`	`setName(String name)` the link mapping
`void`	`setParent(MenuEntry parent)` the parent entry or null if root
`void`	`setResouceMessageKey(String resouceMessageKey)` not implemented
`void`	`setSecurityRoles(Set<String> securityRoles)`
`void`	`setSubmenu(List<MenuEntry> submenu)` list of sub menu entries.
`void`	`setTarget(String targetTemplatePath)` relative path to target template using Thymeleaf default resolve mechanism.
`void`	`setUseCCSHierarchy(boolean useCCSHierarchy)` if this is set to true all css links up to root are collected and used.
`void`	`setUseJSHierarchy(boolean useJSHierarchy)` if this is set to true all css links up to root are collected and used.
`void`	`setVariables(Map<String,Object> variables)` additional variables for the template context e.g.: if you want to access a self created object within the template which is not accessible via Thymeleaf bean resolution.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MenuEntry
```
public MenuEntry()
```
  - MenuEntry
```
public MenuEntry(String name,
                 String displayName,
                 String target)
```
    Parameters:
    
    name - - the link mapping
    
    displayName - - the display name
    
    target - - the template path. see setTarget(String)
  - MenuEntry
```
public MenuEntry(String name,
                 String displayName,
                 String target,
                 Set<String> securityRoles)
```
    Parameters:
    
    name - - the link mapping
    
    displayName - - the display name
    
    target - - the template path. see setTarget(String)
    
    securityRoles - - Set of roles to check against the current user for displaying/hiding menu entries in the frontend
    
    Since:
    
    1.0.1
- Method Detail
  - getName
```
public String getName()
```
    the link mapping
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    the link mapping
    
    Parameters:
    
    name - the name to set
  - getDisplayName
```
public String getDisplayName()
```
    display name shown in the menu
    
    Returns:
    
    the displayName
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    display name shown in the menu
    
    Parameters:
    
    displayName - the displayName to set
  - getResouceMessageKey
```
public String getResouceMessageKey()
```
    not implemented
    
    Returns:
    
    the resouceMessageKey
  - setResouceMessageKey
```
public void setResouceMessageKey(String resouceMessageKey)
```
    not implemented
    
    Parameters:
    
    resouceMessageKey - the resouceMessageKey to set
  - getTarget
```
public String getTarget()
```
    relative path to target template
    
    Returns:
    
    the target template path
    
    See Also:
    
    setTarget(String)
  - setTarget
```
public void setTarget(String targetTemplatePath)
```
    relative path to target template using Thymeleaf default resolve mechanism.
    path should not start with a leading / and should not make use o any file ending
    templates have to be in a "admintool" folder. this is used as prefix!
    
    for example:
    your Thymeleaf is configured to look for templates in: classpath:/templates
    than your template has to be in: /templates/admintool/
    you want to use your own structure: /templates/admintool/myComponent/myMenuTemplate.html
    
    to get the example resolved set target to: myComponent/myMenuTemplate
    
    Parameters:
    
    target - the target template path
  - isHide
```
public boolean isHide()
```
    if set to true this menu entry will be hidden, but still requestable
    
    Returns:
    
    the hide
  - setHide
```
public void setHide(boolean hide)
```
    if set to true this menu entry will be hidden, but still requestable
    
    Parameters:
    
    hide - the hide to set
  - getParent
```
public MenuEntry getParent()
```
    the parent entry or null if root
    
    Returns:
    
    the parent
  - setParent
```
public void setParent(MenuEntry parent)
```
    the parent entry or null if root
    
    Parameters:
    
    parent - the parent to set
  - getSubmenu
```
public List<MenuEntry> getSubmenu()
```
    list of sub menu entries.
    
    Returns:
    
    the submenu
  - setSubmenu
```
public void setSubmenu(List<MenuEntry> submenu)
```
    list of sub menu entries.
    
    Parameters:
    
    submenu - the submenu to set
  - addSubmenuEntry
```
public void addSubmenuEntry(MenuEntry submenu)
```
    add a sub menu entry
    
    Parameters:
    
    mainmenu - the mainmenu to set
  - flattened
```
public Stream<MenuEntry> flattened()
```
    Returns:
    
    a stream of menu entry with all recursive resolved sub menu entries
  - reverseFlattened
```
public Stream<MenuEntry> reverseFlattened()
```
    Returns:
    
    stream of parents (recursive)
  - getAdditionalCSS
```
public Map<String,Boolean> getAdditionalCSS()
```
    Returns:
    
    the additionalCSS
    
    Since:
    
    1.0.3
  - setAdditionalCSS
```
public void setAdditionalCSS(Map<String,Boolean> additionalCSS)
```
    map with paths to CSS.
    
    Parameters:
    
    additionalCSS - the additionalCSS to set
    
    Since:
    
    1.0.3
    
    See Also:
    
    addAdditionalCSS(String, boolean)
  - addAdditionalCSS
```
public void addAdditionalCSS(String additionalCSS,
                             boolean relative)
```
    path to CSS.
    Example:
    addAdditionalCSS("/static/myComponent/css/myStyles.css", true); addAdditionalCSS("http://example.com/styles.css", false);
    
    Parameters:
    
    additionalCSS - the additionalCSS to set
    
    Since:
    
    1.0.3
  - getAdditionalCSSReverse
```
public Map<String,Boolean> getAdditionalCSSReverse()
```
    returns all additional js from this to upper menu item hierarchy beginning with the root.
    
    Returns:
    
    Since:
    
    1.1.4
  - isUseCCSHierarchy
```
public boolean isUseCCSHierarchy()
```
    Returns:
    
    Since:
    
    1.1.4
  - setUseCCSHierarchy
```
public void setUseCCSHierarchy(boolean useCCSHierarchy)
```
    if this is set to true all css links up to root are collected and used.
    this could be usefull if you want to structure your resources in a hierarchy
    
    Parameters:
    
    useCCSHierarchy -
    
    Since:
    
    1.1.4
  - getAdditionalJS
```
public Map<String,Boolean> getAdditionalJS()
```
    Returns:
    
    the additionalJS
    
    Since:
    
    1.0.3
  - setAdditionalJS
```
public void setAdditionalJS(Map<String,Boolean> additionalJS)
```
    map with path to additional JavaScript files.
    
    Parameters:
    
    additionalJS - the additionalJS to set
    
    Since:
    
    1.0.3
    
    See Also:
    
    addAdditionalJS(String, boolean)
  - addAdditionalJS
```
public void addAdditionalJS(String additionalJS,
                            boolean relative)
```
    path to additional JavaScript files.
    Example:
    addAdditionalJS("/static/myComponent/js/myScripts.js", true); addAdditionalJS("http://example.com/script.js", false);
    
    Parameters:
    
    additionalJS - the additionalJS to set
    
    Since:
    
    1.0.3
  - getAdditionalJSReverse
```
public Map<String,Boolean> getAdditionalJSReverse()
```
    returns all additional js from this to upper menu item hierarchy beginning with the root.
    
    Returns:
    
    Since:
    
    1.1.4
  - isUseJSHierarchy
```
public boolean isUseJSHierarchy()
```
    Returns:
    
    Since:
    
    1.1.4
  - setUseJSHierarchy
```
public void setUseJSHierarchy(boolean useJSHierarchy)
```
    if this is set to true all css links up to root are collected and used.
    this could be usefull if you want to structure your resources in a hierarchy
    
    Parameters:
    
    useCCSHierarchy -
    
    Since:
    
    1.1.4
  - getAffectedSecurityRoles
```
public Set<String> getAffectedSecurityRoles()
```
    the effective roles reverse recursive to component if not set at this object or anywhere within the tree
    first menu entry or component with roles will return it.
    
    Returns:
    
    a unmodifiable Set or empty Set
    
    Since:
    
    1.0.1
  - getSecurityRoles
```
public Set<String> getSecurityRoles()
```
    Returns:
    
    the securityRoles
    
    Since:
    
    1.0.1
  - setSecurityRoles
```
public void setSecurityRoles(Set<String> securityRoles)
```
    Parameters:
    
    securityRoles - the securityRoles to set
    
    Since:
    
    1.0.1
  - addSecurityRole
```
public void addSecurityRole(String securityRole)
```
    Parameters:
    
    securityRole - the securityRoles to set
    
    Since:
    
    1.0.1
  - getVariables
```
public Map<String,Object> getVariables()
```
    returns the variables map
    
    Returns:
    
    the variables
  - getVariable
```
public Object getVariable(String key)
```
    returns the menu variable by key
    
    Parameters:
    
    key -
    
    Returns:
    
    Since:
    
    1.1.2
  - setVariables
```
public void setVariables(Map<String,Object> variables)
```
    additional variables for the template context e.g.: if you want to access a self created object within the template which is not accessible via Thymeleaf bean resolution.
    
    Parameters:
    
    variables - the variables to set
  - addVariable
```
public void addVariable(String key,
                        Object variable)
```
    add a additional variable for the template context
    e.g.: if you want to access a self created object within the template which is not accessible via Thymeleaf bean resolution.
    
    Parameters:
    
    variables - the variables to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MenuEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MenuEntry

MenuEntry

MenuEntry

Method Detail

getName

setName

getDisplayName

setDisplayName

getResouceMessageKey

setResouceMessageKey

getTarget

setTarget

isHide

setHide

getParent

setParent

getSubmenu

setSubmenu

addSubmenuEntry

flattened

reverseFlattened

getAdditionalCSS

setAdditionalCSS

addAdditionalCSS

getAdditionalCSSReverse

isUseCCSHierarchy

setUseCCSHierarchy

getAdditionalJS

setAdditionalJS

addAdditionalJS

getAdditionalJSReverse

isUseJSHierarchy

setUseJSHierarchy

getAffectedSecurityRoles

getSecurityRoles

setSecurityRoles

addSecurityRole

getVariables

getVariable

setVariables

addVariable

toString