uk.co.keang.hex.gui
Enum HexLayout.HexLayoutStyle

java.lang.Object
  extended by java.lang.Enum<HexLayout.HexLayoutStyle>
      extended by uk.co.keang.hex.gui.HexLayout.HexLayoutStyle
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HexLayout.HexLayoutStyle>
Enclosing class:
HexLayout

public static enum HexLayout.HexLayoutStyle
extends java.lang.Enum<HexLayout.HexLayoutStyle>

An enum defining the layout styles available

Author:
A.G.Docherty

Enum Constant Summary
STRAIGHT_MAX_FIRST
           
STRAIGHT_MIN_FIRST
           
WAVEY
           
 
Method Summary
(package private) abstract  int maxComponentsPerLine(int nComponents, int nLines)
           
(package private) abstract  int numComponentsThisLine(int ncols, int line)
           
(package private) abstract  int numLines(int nComponents, int maxPerLine)
           
static HexLayout.HexLayoutStyle valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HexLayout.HexLayoutStyle[] 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

WAVEY

public static final HexLayout.HexLayoutStyle WAVEY

STRAIGHT_MIN_FIRST

public static final HexLayout.HexLayoutStyle STRAIGHT_MIN_FIRST

STRAIGHT_MAX_FIRST

public static final HexLayout.HexLayoutStyle STRAIGHT_MAX_FIRST
Method Detail

values

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

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

valueOf

public static HexLayout.HexLayoutStyle 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

numComponentsThisLine

abstract int numComponentsThisLine(int ncols,
                                   int line)

numLines

abstract int numLines(int nComponents,
                      int maxPerLine)

maxComponentsPerLine

abstract int maxComponentsPerLine(int nComponents,
                                  int nLines)