SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum Overflow

java.lang.Object
  extended by java.lang.Enum<Overflow>
      extended by org.axsl.common.value.Overflow
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Overflow>

public enum Overflow
extends java.lang.Enum<Overflow>

Enumeration of valid "overflow" values, that is, the property that tells what to do when the content of an element overflows its Area. See XSL-FO 1.1, Section 7.21.2.


Enum Constant Summary
AUTO
          Provides a scrolling mechanism for overflowing boxes.
ERROR_IF_OVERFLOW
          Implies the same as "hidden", but with an error indicated.
HIDDEN
          The content is clipped, and no scrolling mechanism is provided.
REPEAT
          The meaning of this value is unclear.
SCROLL
          The content is clipped, and a scrolling mechanism is provided.
VISIBLE
          The content is not clipped, that is, it may be rendered outside of its area.
 
Method Summary
static Overflow valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Overflow[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

VISIBLE

public static final Overflow VISIBLE
The content is not clipped, that is, it may be rendered outside of its area.


HIDDEN

public static final Overflow HIDDEN
The content is clipped, and no scrolling mechanism is provided.


SCROLL

public static final Overflow SCROLL
The content is clipped, and a scrolling mechanism is provided.


ERROR_IF_OVERFLOW

public static final Overflow ERROR_IF_OVERFLOW
Implies the same as "hidden", but with an error indicated.


REPEAT

public static final Overflow REPEAT
The meaning of this value is unclear.


AUTO

public static final Overflow AUTO
Provides a scrolling mechanism for overflowing boxes.

Method Detail

values

public static final Overflow[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Overflow c : Overflow.values())
        System.out.println(c);

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

valueOf

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

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.