Enum PageItem.SnapClass
- java.lang.Object
-
- java.lang.Enum<PageItem.SnapClass>
-
- ca.cgjennings.apps.arkham.deck.item.PageItem.SnapClass
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PageItem.SnapClass>
- Enclosing interface:
- PageItem
public static enum PageItem.SnapClass extends java.lang.Enum<PageItem.SnapClass>
An enumeration of the general classes of items used to determine how an item will behave when snapped and what it can snap against.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description SNAP_CARD
Class representing card faces.SNAP_INLAY
Class representing inlays: overlays that are normallyTARGET_MIXED
.SNAP_OTHER
Class representing default, other, or unknown objects.SNAP_OVERLAY
Class representing overlays, e.g.SNAP_PAGE_GRID
Class representing the gridlines on the deck page.SNAP_TILE
Class representing tiles.
-
Field Summary
Fields Modifier and Type Field Description static java.util.EnumSet<PageItem.SnapClass>
SNAP_SET_ANY
APageItem.SnapClass
set for items that will snap against anything.static java.util.EnumSet<PageItem.SnapClass>
SNAP_SET_NONE
APageItem.SnapClass
set for items that do not snap but are always dropped in place.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static PageItem.SnapClass
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PageItem.SnapClass[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SNAP_PAGE_GRID
public static final PageItem.SnapClass SNAP_PAGE_GRID
Class representing the gridlines on the deck page.
-
SNAP_CARD
public static final PageItem.SnapClass SNAP_CARD
Class representing card faces.
-
SNAP_TILE
public static final PageItem.SnapClass SNAP_TILE
Class representing tiles.
-
SNAP_OVERLAY
public static final PageItem.SnapClass SNAP_OVERLAY
Class representing overlays, e.g. misc decorations.
-
SNAP_INLAY
public static final PageItem.SnapClass SNAP_INLAY
Class representing inlays: overlays that are normallyTARGET_MIXED
.
-
SNAP_OTHER
public static final PageItem.SnapClass SNAP_OTHER
Class representing default, other, or unknown objects.
-
-
Field Detail
-
SNAP_SET_NONE
public static final java.util.EnumSet<PageItem.SnapClass> SNAP_SET_NONE
APageItem.SnapClass
set for items that do not snap but are always dropped in place. This set is shared; its contents must not be modified.
-
SNAP_SET_ANY
public static final java.util.EnumSet<PageItem.SnapClass> SNAP_SET_ANY
APageItem.SnapClass
set for items that will snap against anything. This set is shared; its contents must not be modified.
-
-
Method Detail
-
values
public static PageItem.SnapClass[] 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 (PageItem.SnapClass c : PageItem.SnapClass.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PageItem.SnapClass valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-