Enum NavigationBarItemType
- java.lang.Object
-
- java.lang.Enum<NavigationBarItemType>
-
- com.redwood.scheduler.api.model.enumeration.NavigationBarItemType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<NavigationBarItemType,Character>
,SchedulerEnumeration<NavigationBarItemType>
,Serializable
,Comparable<NavigationBarItemType>
public enum NavigationBarItemType extends Enum<NavigationBarItemType> implements SchedulerEnumeration<NavigationBarItemType>
What kind of navigation bar item is this. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Action
Item is of type action.Application
Item is of type application.ExtensionPoint
Item is of type extension point.ExtensionPointGroup
Item is of type extension point group.Group
Item is of type group.Overview
Item is of type overview.Settings
Item is of type settings.Shortcut
Item is of type shortcut.TreeGroup
Item is of type tree group.
-
Field Summary
Fields Modifier and Type Field Description static char
ActionCode
The char returned from Action.getCodeEx().static char
ApplicationCode
The char returned from Application.getCodeEx().static char
ExtensionPointCode
The char returned from ExtensionPoint.getCodeEx().static char
ExtensionPointGroupCode
The char returned from ExtensionPointGroup.getCodeEx().static char
GroupCode
The char returned from Group.getCodeEx().static char
OverviewCode
The char returned from Overview.getCodeEx().static char
SettingsCode
The char returned from Settings.getCodeEx().static char
ShortcutCode
The char returned from Shortcut.getCodeEx().static char
TreeGroupCode
The char returned from TreeGroup.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static NavigationBarItemType
safeValueOf(String value)
Helper function to return the NavigationBarItemType represented byvalue
.static NavigationBarItemType
valueOf(char code)
Helper function to return the NavigationBarItemType represented by code.static NavigationBarItemType
valueOf(Character code)
Helper function to return the NavigationBarItemType represented by code.static NavigationBarItemType
valueOf(String name)
Returns the enum constant of this type with the specified name.static NavigationBarItemType
valueOfCode(String code)
Helper function to return the NavigationBarItemType represented by code.static NavigationBarItemType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Group
public static final NavigationBarItemType Group
Item is of type group.
-
Overview
public static final NavigationBarItemType Overview
Item is of type overview.
-
Shortcut
public static final NavigationBarItemType Shortcut
Item is of type shortcut.
-
Application
public static final NavigationBarItemType Application
Item is of type application.
-
Settings
public static final NavigationBarItemType Settings
Item is of type settings.
-
TreeGroup
public static final NavigationBarItemType TreeGroup
Item is of type tree group.
-
Action
public static final NavigationBarItemType Action
Item is of type action.
-
ExtensionPointGroup
public static final NavigationBarItemType ExtensionPointGroup
Item is of type extension point group.
-
ExtensionPoint
public static final NavigationBarItemType ExtensionPoint
Item is of type extension point.
-
-
Field Detail
-
GroupCode
public static final char GroupCode
The char returned from Group.getCodeEx().- See Also:
Group
, Constant Field Values
-
OverviewCode
public static final char OverviewCode
The char returned from Overview.getCodeEx().- See Also:
Overview
, Constant Field Values
-
ShortcutCode
public static final char ShortcutCode
The char returned from Shortcut.getCodeEx().- See Also:
Shortcut
, Constant Field Values
-
ApplicationCode
public static final char ApplicationCode
The char returned from Application.getCodeEx().- See Also:
Application
, Constant Field Values
-
SettingsCode
public static final char SettingsCode
The char returned from Settings.getCodeEx().- See Also:
Settings
, Constant Field Values
-
TreeGroupCode
public static final char TreeGroupCode
The char returned from TreeGroup.getCodeEx().- See Also:
TreeGroup
, Constant Field Values
-
ActionCode
public static final char ActionCode
The char returned from Action.getCodeEx().- See Also:
Action
, Constant Field Values
-
ExtensionPointGroupCode
public static final char ExtensionPointGroupCode
The char returned from ExtensionPointGroup.getCodeEx().- See Also:
ExtensionPointGroup
, Constant Field Values
-
ExtensionPointCode
public static final char ExtensionPointCode
The char returned from ExtensionPoint.getCodeEx().- See Also:
ExtensionPoint
, Constant Field Values
-
-
Method Detail
-
values
public static NavigationBarItemType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NavigationBarItemType c : NavigationBarItemType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NavigationBarItemType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOfCode
public static NavigationBarItemType valueOfCode(String code)
Helper function to return the NavigationBarItemType represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for NavigationBarItemType- Returns:
- The NavigationBarItemType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static NavigationBarItemType safeValueOf(String value)
Helper function to return the NavigationBarItemType represented byvalue
. Ifvalue
is null, or not a valid NavigationBarItemType enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The NavigationBarItemType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static NavigationBarItemType valueOf(Character code)
Helper function to return the NavigationBarItemType represented by code. If code is null, or not a valid NavigationBarItemType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The NavigationBarItemType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static NavigationBarItemType valueOf(char code)
Helper function to return the NavigationBarItemType represented by code. If code is not a valid NavigationBarItemType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The NavigationBarItemType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<NavigationBarItemType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<NavigationBarItemType,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<NavigationBarItemType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<NavigationBarItemType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<NavigationBarItemType,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<NavigationBarItemType,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<NavigationBarItemType>
- Returns:
- the database code for the enumeration
-
-