com.almworks.jira.structure.api.settings

Enum StructurePage

Object

Enum<StructurePage>

StructurePage

All Implemented Interfaces:

Serializable, Comparable<StructurePage>

public enum StructurePage
extends Enum<StructurePage>

StructurePage enum lists all non-admin JIRA pages (page types) that display Structure Widget or that are adjusted by Structure Plugin. It is used to define per-page user interface settings.

Author:

Igor Sereda

See Also:

UISettings

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPONENT_TAB "Structure" tab on the component page.
GADGET Structure Gadget - either on Dashboard or in Confluence.
GREENHOPPER_TAB "Structure" Tab in the issue details view on GreenHopper rapid board
ISSUE_NAVIGATOR Issue navigator - for now, Structure is present only as a Views menu element.
ISSUE_VIEW The page with a single issue.
PROJECT_TAB "Structure" tab on the project page.
STRUCTURE_BOARD Structure Board page - the one that opens when you click Structure in the top menu bar.
STRUCTURE_BOARD_WITH_DETAILS Deprecated. No longer supported since Structure doesn't use a separate view for a details panel layout. Use STRUCTURE_BOARD or PROJECT_TAB instead.
VERSION_TAB "Structure" tab on the version page.

Method Summary

Modifier and Type	Method and Description
static EnumSet<StructurePage>	enumSet(Collection<StructurePage> pages)
static StructurePage	forId(String id)
String	getId()
static StructurePage	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructurePage[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRUCTURE_BOARD

public static final StructurePage STRUCTURE_BOARD

Structure Board page - the one that opens when you click Structure in the top menu bar.

STRUCTURE_BOARD_WITH_DETAILS

@Deprecated
public static final StructurePage STRUCTURE_BOARD_WITH_DETAILS

Deprecated. No longer supported since Structure doesn't use a separate view for a details panel layout. Use STRUCTURE_BOARD or PROJECT_TAB instead.

Either Structure Board page with issue details panel or Project page with issue details panel.

ISSUE_VIEW

public static final StructurePage ISSUE_VIEW

The page with a single issue.

PROJECT_TAB

public static final StructurePage PROJECT_TAB

"Structure" tab on the project page.

COMPONENT_TAB

public static final StructurePage COMPONENT_TAB

"Structure" tab on the component page.

VERSION_TAB

public static final StructurePage VERSION_TAB

"Structure" tab on the version page.

ISSUE_NAVIGATOR

public static final StructurePage ISSUE_NAVIGATOR

Issue navigator - for now, Structure is present only as a Views menu element.

GADGET

public static final StructurePage GADGET

Structure Gadget - either on Dashboard or in Confluence.

GREENHOPPER_TAB

public static final StructurePage GREENHOPPER_TAB

"Structure" Tab in the issue details view on GreenHopper rapid board

Method Detail

values

public static StructurePage[] 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 (StructurePage c : StructurePage.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StructurePage 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 name

NullPointerException - if the argument is null

getId

public String getId()

forId

@Nullable
public static StructurePage forId(@Nullable
                                            String id)

enumSet

@Nullable
public static EnumSet<StructurePage> enumSet(@Nullable
                                                       Collection<StructurePage> pages)