Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.pdfclown.documents.contents.layers
Enum ListModeEnum

    java.lang.Object
      java.lang.Enum<ListModeEnum>
          org.pdfclown.documents.contents.layers.ListModeEnum

All Implemented Interfaces:
  Serializable, Comparable<ListModeEnum>

    public enum ListModeEnum

extends Enum<ListModeEnum>

List mode specifying which layers should be displayed to the user.

Since:
  0.1.1
Version:
  0.1.1, 06/08/11
Author:
  Stefano Chizzolini (http://www.stefanochizzolini.it)

Enum Constant Summary
`AllPages` All the layers are displayed.
`VisiblePages` Only the layers referenced by one or more visible pages are displayed.

Method Summary
`PdfName` | `getName()`
`static ListModeEnum` | `valueOf(PdfName name)`
`static ListModeEnum` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ListModeEnum[]` | `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

### AllPages

    public static final ListModeEnum AllPages

  All the layers are displayed.

### VisiblePages

    public static final ListModeEnum VisiblePages

  Only the layers referenced by one or more visible pages are displayed.

Method Detail

### values

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

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

### valueOf

    public static ListModeEnum 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

### valueOf

    public static ListModeEnum valueOf(PdfName name)

### getName

    public PdfName getName()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

Project home page
Copyright © 2006-2013 Stefano Chizzolini. Some Rights Reserved.
This documentation is available under the terms of the GNU Free Documentation License.