Package ca.cgjennings.apps.arkham.diy

Enum DIY.FaceStyle

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CARD_AND_MARKER
      The component consists of a total of four faces, but only three are shown.
      EIGHT_FACES
      The component consists of a total of eight faces.
      FOUR_FACES
      The component consists of a total of four faces.
      ONE_FACE
      The component is a card or other object with only a font face.
      PLAIN_BACK
      The component has two faces, but the back is just a static image.
      SHARED_FACE
      The component is a card or other object with two faces, but both faces are identical.
      SIX_FACES
      The component consists of a total of six faces.
      TWO_FACES
      The component is a card or other object with two faces, each of which has its own painter.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getFaceCount()
      Returns the number of faces (sheets) that are used by this face style.
      static DIY.FaceStyle valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DIY.FaceStyle[] 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_FACE

        public static final DIY.FaceStyle ONE_FACE
        The component is a card or other object with only a font face.

      • TWO_FACES

        public static final DIY.FaceStyle TWO_FACES
        The component is a card or other object with two faces, each of which has its own painter.

      • SHARED_FACE

        public static final DIY.FaceStyle SHARED_FACE
        The component is a card or other object with two faces, but both faces are identical.

      • PLAIN_BACK

        public static final DIY.FaceStyle PLAIN_BACK
        The component has two faces, but the back is just a static image. The image specified by the back image template key will be used to create a a back face painter automatically.

      • CARD_AND_MARKER

        public static final DIY.FaceStyle CARD_AND_MARKER
        The component consists of a total of four faces, but only three are shown. This is a special case to handle the commonly found combination of a character card with an accompanying marker. The first two faces of the component represent the character card, while the third face represents one side of the marker (the other side is a mirror image). If the default portrait handling system is used, then the component will have an additional portrait panel to adjust the location and scale of the portrait on the marker (the image will be identical to the main portrait image).

      • FOUR_FACES

        public static final DIY.FaceStyle FOUR_FACES
        The component consists of a total of four faces. Typically, the component is a pair of closely related cards. The front painting functions are called for the first and third face, and the back painting functions are called for the second and fourth face. You can tell which face is requested by calling the DIYSheet.getSheetIndex() method of the passed-in sheet.

      • SIX_FACES

        public static final DIY.FaceStyle SIX_FACES
        The component consists of a total of six faces. Typically, the component is a triple of closely related cards, or a pair of cards and a double-sided marker. The front painting functions are called for the odd-numbered faces (first, third, fifth), and the back painting functions are called for the even-numbered faces (second, fourth, sixth). You can tell which face is requested by calling the DIYSheet.getSheetIndex() method of the passed-in sheet.

      • EIGHT_FACES

        public static final DIY.FaceStyle EIGHT_FACES
        The component consists of a total of eight faces. Typically, the component is a quadruple of closely related cards, or a triple of cards and a double-sided marker. The front painting functions are called for the odd-numbered faces (first, third, fifth, seventh), and the back painting functions are called for the even-numbered faces (second, fourth, sixth, eighth). You can tell which face is requested by calling the DIYSheet.getSheetIndex() method of the passed-in sheet. Eight faces is about the limit of what a user can reasonably work with from a single editor; if you have more related faces than this, try to find a way to split the design into two or more editors. You can always add a button to create or import the common content for the second editor automatically from the first.

    • Method Detail

      • values

        public static DIY.FaceStyle[] 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 (DIY.FaceStyle c : DIY.FaceStyle.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DIY.FaceStyle 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

      • getFaceCount

        public int getFaceCount()
        Returns the number of faces (sheets) that are used by this face style. For example, SHARED_FACE.getFaceCount() would return 2, while SIX_FACES.getFaceCount() would return 6.
        Returns:
        the number of sheets associated with this face style