MarkerStyle (Strange Eons API)

java.lang.Object
- java.lang.Enum<MarkerStyle>
- - ca.cgjennings.apps.arkham.sheet.MarkerStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MarkerStyle>
```
public enum MarkerStyle
extends java.lang.Enum<MarkerStyle>
```
An enumeration of the possible types of embedded markers. An embedded marker is a marker that is represented by one of the sheets for a game component. An embedded marker is closely related to the sheets for the rest of the component, but is not the primary content represented by those sheets. A typical example is a game component for a player character which includes sheets for the character statistics along with a separate sheet for a character marker used to indicate the character's location on a board. It is easier for the user to design both together since the same character portrait will probably be used on both the character sheet and the marker.
Embedded tokens are unique in that they consist of a single sheet, but when printed (or when decks are generated that include them) that single sheet may be replicated automatically to create a double-sided token. When a sheet has a non-null MarkerStyle, this both declares that the sheet represents an embedded marker and determines how it is copied for print layouts.

Since:

3.0

Author:

Chris Jennings

See Also:

Sheet.getMarkerStyle()

Enum Constant Summary

Enum Constants
Enum Constant	Description
`COPIED`	A back side that is identical to the front side will be generated.
`MIRRORED`	A back side that is a mirror image of the front side will be generated.
`ONE_SIDED`	No second side will be generated for this embedded marker.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static MarkerStyle`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static MarkerStyle[]`	`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ONE_SIDED
```
public static final MarkerStyle ONE_SIDED
```
    No second side will be generated for this embedded marker.
  - COPIED
```
public static final MarkerStyle COPIED
```
    A back side that is identical to the front side will be generated.
  - MIRRORED
```
public static final MarkerStyle MIRRORED
```
    A back side that is a mirror image of the front side will be generated.
- Method Detail
  - values
```
public static MarkerStyle[] 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 (MarkerStyle c : MarkerStyle.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MarkerStyle 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 name
    
    java.lang.NullPointerException - if the argument is null