Package org.rundeck.app.gui
Interface MenuItem
-
- All Known Subinterfaces:
AuthMenuItem
,GroupedMenuItem
public interface MenuItem
Define a menu item with a link
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
MenuItem.MenuDomain
static class
MenuItem.MenuType
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static java.util.function.Function<MenuItem,java.lang.Boolean>
getEnabledCheck(MenuItem.MenuType menuType, java.lang.String project, java.lang.String executionId)
default java.lang.String
getExecutionHref(java.lang.String project, java.lang.String executionId)
default java.lang.String
getHref()
Location HREFdefault java.lang.String
getIconCSS()
default java.lang.Integer
getPriority()
Sort keydefault java.lang.String
getProjectHref(java.lang.String project)
java.lang.String
getTitle()
Default title stringjava.lang.String
getTitleCode()
i18n message code for titleMenuItem.MenuType
getType()
Location of menu itemdefault boolean
isEnabled()
default boolean
isEnabled(java.lang.String project)
default boolean
isEnabledExecution(java.lang.String project, java.lang.String executionId)
-
-
-
Method Detail
-
getType
MenuItem.MenuType getType()
Location of menu item
-
getPriority
default java.lang.Integer getPriority()
Sort key
-
getTitleCode
java.lang.String getTitleCode()
i18n message code for title
-
getTitle
java.lang.String getTitle()
Default title string
-
getHref
default java.lang.String getHref()
Location HREF
-
getProjectHref
default java.lang.String getProjectHref(java.lang.String project)
- Parameters:
project
-
-
getExecutionHref
default java.lang.String getExecutionHref(java.lang.String project, java.lang.String executionId)
-
getIconCSS
default java.lang.String getIconCSS()
- Returns:
- css class string for icon in certain menu locations, or null for a default, e.g. 'fas fa-check' for font-awesome, or 'glyphicon glyphicon-ok' for glyphicon
-
isEnabled
default boolean isEnabled()
- Returns:
- true if enabled, false if disabled
-
isEnabled
default boolean isEnabled(java.lang.String project)
- Parameters:
project
- name for project oriented items- Returns:
- true if enabled, false if disabled
-
isEnabledExecution
default boolean isEnabledExecution(java.lang.String project, java.lang.String executionId)
- Parameters:
project
- name for project oriented itemsexecutionId
- execution Id for Execution menu items- Returns:
- true if enabled, false if disabled
-
getEnabledCheck
static java.util.function.Function<MenuItem,java.lang.Boolean> getEnabledCheck(MenuItem.MenuType menuType, java.lang.String project, java.lang.String executionId)
- Parameters:
menuType
- menu types to checkproject
- project name, if available and project type should be checkedexecutionId
- execution ID string, if available and execution type should be checked- Returns:
- enabled check function given the input values
-
-