com.levigo.jadice.swing.pageview
Enum PageView.Layout

java.lang.Object
  java.lang.Enum<PageView.Layout>
      com.levigo.jadice.swing.pageview.PageView.Layout

All Implemented Interfaces:

Serializable, Comparable<PageView.Layout>

Enclosing class:

PageView

public static enum PageView.Layout
extends Enum<PageView.Layout>

These layout style constants define a set of well-known page layout styles. Caveat: The various layout styles are actually implemented by instances of PageLayout, however, the latter is not public API.

Enum Constant Summary

CONTINUOUS_PAGE
A layout where all pages are laid out as a vertical, one page wide sequence of pages.

CONTINUOUS_SPREAD
A layout where all pages are laid out as a vertical, two page wide sequence of page spreads.

GRID
A layout where all pages are laid out as a grid.

PAGE
A layout where only a single page is visible at a time.

SPREAD
A layout where two adjacent pages of a spread (e.g.

Field Summary

Class<? extends com.levigo.jadice.swing.pageview.PageLayout>

layoutClass

Method Summary

boolean	canHandle(PageView pageView, Document document) This method is not part of the public API at this time.
static PageView.Layout	valueOf(String name) Returns the enum constant of this type with the specified name.
static PageView.Layout[]	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

PAGE

public static final PageView.Layout PAGE

A layout where only a single page is visible at a time.

CONTINUOUS_PAGE

public static final PageView.Layout CONTINUOUS_PAGE

A layout where all pages are laid out as a vertical, one page wide sequence of pages.

SPREAD

public static final PageView.Layout SPREAD

A layout where two adjacent pages of a spread (e.g. two pages bound side-by-side in a book) are displayed at a time. If the first page is a right or the last page a left one, only one page is shown.

CONTINUOUS_SPREAD

public static final PageView.Layout CONTINUOUS_SPREAD

A layout where all pages are laid out as a vertical, two page wide sequence of page spreads.

GRID

public static final PageView.Layout GRID

A layout where all pages are laid out as a grid. The grid's width (i.e. number of pages in a row) will be determined by the available space.

Field Detail

layoutClass

public final Class<? extends com.levigo.jadice.swing.pageview.PageLayout> layoutClass

Method Detail

values

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

Returns:

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

valueOf

public static PageView.Layout 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

canHandle

public boolean canHandle(PageView pageView,
                         Document document)

This method is not part of the public API at this time. Do not use.

Returns:

true if this layout type can handle the given document; false otherwise.

See Also:

PageLayout.canHandle(Document)