org.axsl.common.value
Enum IntrusionDisplace

java.lang.Object
  java.lang.Enum<IntrusionDisplace>
      org.axsl.common.value.IntrusionDisplace

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IntrusionDisplace>

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

Enumeration of possible "intrusion-displace" values.

Enum Constant Summary

BLOCK
The start edge (and end edge) of the block is displaced by the least amount necessary to insure that (a) the start edge (end edge) of the block does not intersect any of the start intrusions (end intrusions) that overlap that block and (b) the amount by which it is displaced is at least as much as the displacement of the parent area, provided the parent is a block-area which is not a reference-area.

INDENT
The start edge (and end edge) of each line within the block area on which the property occurs is displaced (a) by at least the same amount it would be displaced by the "line" value of this property and (b) in addition, by an amount that preserves the relative offset of that start edge (or end edge) with respect to the start edge (or end edge) of any other line displaced by any intrusion that cause the current line to be displaced.

LINE
The start and end edges of line areas are displaced just enough so that any intrusions no longer intersect the content rectangle of the line area.

NONE
Neither line areas nor block areas are displaced (nor have any adjustment to their inline progressin dimension) due to the intrusion of the float.

Method Summary

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

NONE

public static final IntrusionDisplace NONE

Neither line areas nor block areas are displaced (nor have any adjustment to their inline progressin dimension) due to the intrusion of the float. The float overlays the area without affecting any of the content of the area, unless the "clear" property has a specified value other than "none".

LINE

public static final IntrusionDisplace LINE

The start and end edges of line areas are displaced just enough so that any intrusions no longer intersect the content rectangle of the line area. For the purposes of this test, the allocation rectangle of the intrusion is used in the intersection. Also, such intersections are done with respect to the line area prior to its adjustment of any "text-indent." This will cause a reduction in the inline progression dimension of the line area.

INDENT

public static final IntrusionDisplace INDENT

The start edge (and end edge) of each line within the block area on which the property occurs is displaced (a) by at least the same amount it would be displaced by the "line" value of this property and (b) in addition, by an amount that preserves the relative offset of that start edge (or end edge) with respect to the start edge (or end edge) of any other line displaced by any intrusion that cause the current line to be displaced. If there is more than one intrusion that could cause a displacement of the line, the largest such displacement is used.

BLOCK

public static final IntrusionDisplace BLOCK

The start edge (and end edge) of the block is displaced by the least amount necessary to insure that (a) the start edge (end edge) of the block does not intersect any of the start intrusions (end intrusions) that overlap that block and (b) the amount by which it is displaced is at least as much as the displacement of the parent area, provided the parent is a block-area which is not a reference-area. An intrusion is said to overlap a block if there is a line parallel to the inline progression direction that intersects the allocation rectangles of both the block and the intrusion.

Method Detail

values

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

Returns:

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

valueOf

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