com.levigo.jadice.document.render
Enum BaseRenderSettings.Clipping

java.lang.Object
  java.lang.Enum<BaseRenderSettings.Clipping>
      com.levigo.jadice.document.render.BaseRenderSettings.Clipping

All Implemented Interfaces:

Serializable, Comparable<BaseRenderSettings.Clipping>

Enclosing class:

BaseRenderSettings

public static enum BaseRenderSettings.Clipping
extends Enum<BaseRenderSettings.Clipping>

An enumeration describing what kind of clipping is applied before rendering a part of the model (which usually starts at the page level).

Enum Constant Summary

DEFAULT
The default clipping is applied.

NONE
No clipping is applied.

Method Summary

static BaseRenderSettings.Clipping	valueOf(String name) Returns the enum constant of this type with the specified name.
static BaseRenderSettings.Clipping[]	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

NONE

public static final BaseRenderSettings.Clipping NONE

No clipping is applied. As a consequence, all model elements are rendered, whether they fall outside of the page, media etc. or not.

DEFAULT

public static final BaseRenderSettings.Clipping DEFAULT

The default clipping is applied. The default clipping is equivalent to the page's bounds as returned by the union of its contained page segments' bounds (see PageSegment.getBounds()).

Method Detail

values

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

Returns:

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

valueOf

public static BaseRenderSettings.Clipping 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