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.interaction.actions
Enum OptionsEnum

    java.lang.Object
      java.lang.Enum<OptionsEnum>
          org.pdfclown.documents.interaction.actions.OptionsEnum

All Implemented Interfaces:
  Serializable, Comparable<OptionsEnum>

    public enum OptionsEnum

extends Enum<OptionsEnum>

Action options.

Since:
  0.0.7
Version:
  0.1.0
Author:
  Stefano Chizzolini (http://www.stefanochizzolini.it)

Enum Constant Summary
`NewWindow` Whether to open the destination document in a new window.
`SameWindow` Whether to open the destination document in the current window.

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

### NewWindow

    public static final OptionsEnum NewWindow

  Whether to open the destination document in a new window.

### SameWindow

    public static final OptionsEnum SameWindow

  Whether to open the destination document in the current window.

Method Detail

### values

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

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

### valueOf

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

### getCode

    public int getCode()

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.