fop 0.91beta

org.apache.fop.area
Class Trait

java.lang.Object
  |
  +--org.apache.fop.area.Trait
All Implemented Interfaces:
java.io.Serializable

public class Trait
extends java.lang.Object
implements java.io.Serializable

Area traits used for rendering. This class represents an area trait that specifies a value for rendering.

See Also:
Serialized Form

Inner Class Summary
static class Trait.Background
          Background trait structure.
 
Field Summary
static java.lang.Integer BACKGROUND
          Background trait for an area.
static java.lang.Integer BLINK
          Blinking trait used when rendering inline parent.
static java.lang.Integer BORDER_AFTER
          The border after.
static java.lang.Integer BORDER_BEFORE
          The border before.
static java.lang.Integer BORDER_END
          The border end.
static java.lang.Integer BORDER_START
          The border start.
static java.lang.Integer BREAK_AFTER
          break after
static java.lang.Integer BREAK_BEFORE
          break before
static java.lang.Integer COLOR
          The current colour.
static java.lang.Integer END_INDENT
          The end-indent trait.
static java.lang.Integer EXTERNAL_LINK
          External link.
static java.lang.Integer FONT_NAME
          The font name from the font setup.
static java.lang.Integer FONT_SIZE
          Font size for the current font.
static java.lang.Integer ID_LINK
          Id reference line, not resolved. not sure if this is needed.
static java.lang.Integer INTERNAL_LINK
          Internal link trait.
static java.lang.Integer IS_REFERENCE_AREA
          The is-reference-area trait.
static java.lang.Integer IS_VIEWPORT_AREA
          The is-viewport-area trait.
static java.lang.Integer LINETHROUGH
          Linethrough trait used when rendering inline parent.
static java.lang.Integer LINETHROUGH_COLOR
          Trait for color of linethrough decorations when rendering inline parent.
static java.lang.Integer OFFSET
          Shadow offset.
static java.lang.Integer OVERLINE
          Overline trait used when rendering inline parent.
static java.lang.Integer OVERLINE_COLOR
          Trait for color of overline decorations when rendering inline parent.
static java.lang.Integer PADDING_AFTER
          The padding after.
static java.lang.Integer PADDING_BEFORE
          The padding before.
static java.lang.Integer PADDING_END
          The padding end.
static java.lang.Integer PADDING_START
          The padding start.
static java.lang.Integer PROD_ID
          The ID of the FO that produced an area.
static java.lang.Integer SHADOW
          The shadow for text.
static java.lang.Integer SPACE_AFTER
          The space-after trait.
static java.lang.Integer SPACE_BEFORE
          The space-before trait.
static java.lang.Integer SPACE_END
          The space end.
static java.lang.Integer SPACE_START
          The space start.
static java.lang.Integer START_INDENT
          The start-indent trait.
static java.lang.Integer UNDERLINE
          Underline trait used when rendering inline parent.
static java.lang.Integer UNDERLINE_COLOR
          Trait for color of underline decorations when rendering inline parent.
 
Constructor Summary
Trait()
          Create a new empty trait.
Trait(java.lang.Object propType, java.lang.Object data)
          Create a trait with the value and type.
 
Method Summary
 java.lang.Object getData()
          Returns the trait data value.
 java.lang.Object getPropType()
          Returns the property type.
static java.lang.Object getTraitCode(java.lang.String sTraitName)
          Get the trait code for a trait name.
static java.lang.String getTraitName(java.lang.Object traitCode)
          Get the trait name for a trait code.
static java.lang.Object makeTraitValue(java.lang.Object oCode, java.lang.String sTraitValue)
          Make a trait value.
 java.lang.String toString()
          Return the string for debugging.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID_LINK

public static final java.lang.Integer ID_LINK
Id reference line, not resolved. not sure if this is needed.

INTERNAL_LINK

public static final java.lang.Integer INTERNAL_LINK
Internal link trait. This is resolved and provides a link to an internal area.

EXTERNAL_LINK

public static final java.lang.Integer EXTERNAL_LINK
External link. A URL link to an external resource.

FONT_NAME

public static final java.lang.Integer FONT_NAME
The font name from the font setup.

FONT_SIZE

public static final java.lang.Integer FONT_SIZE
Font size for the current font.

COLOR

public static final java.lang.Integer COLOR
The current colour.

PROD_ID

public static final java.lang.Integer PROD_ID
The ID of the FO that produced an area.

BACKGROUND

public static final java.lang.Integer BACKGROUND
Background trait for an area.

UNDERLINE

public static final java.lang.Integer UNDERLINE
Underline trait used when rendering inline parent.

OVERLINE

public static final java.lang.Integer OVERLINE
Overline trait used when rendering inline parent.

LINETHROUGH

public static final java.lang.Integer LINETHROUGH
Linethrough trait used when rendering inline parent.

OFFSET

public static final java.lang.Integer OFFSET
Shadow offset.

SHADOW

public static final java.lang.Integer SHADOW
The shadow for text.

BORDER_START

public static final java.lang.Integer BORDER_START
The border start.

BORDER_END

public static final java.lang.Integer BORDER_END
The border end.

BORDER_BEFORE

public static final java.lang.Integer BORDER_BEFORE
The border before.

BORDER_AFTER

public static final java.lang.Integer BORDER_AFTER
The border after.

PADDING_START

public static final java.lang.Integer PADDING_START
The padding start.

PADDING_END

public static final java.lang.Integer PADDING_END
The padding end.

PADDING_BEFORE

public static final java.lang.Integer PADDING_BEFORE
The padding before.

PADDING_AFTER

public static final java.lang.Integer PADDING_AFTER
The padding after.

SPACE_START

public static final java.lang.Integer SPACE_START
The space start.

SPACE_END

public static final java.lang.Integer SPACE_END
The space end.

BREAK_BEFORE

public static final java.lang.Integer BREAK_BEFORE
break before

BREAK_AFTER

public static final java.lang.Integer BREAK_AFTER
break after

START_INDENT

public static final java.lang.Integer START_INDENT
The start-indent trait.

END_INDENT

public static final java.lang.Integer END_INDENT
The end-indent trait.

SPACE_BEFORE

public static final java.lang.Integer SPACE_BEFORE
The space-before trait.

SPACE_AFTER

public static final java.lang.Integer SPACE_AFTER
The space-after trait.

IS_REFERENCE_AREA

public static final java.lang.Integer IS_REFERENCE_AREA
The is-reference-area trait.

IS_VIEWPORT_AREA

public static final java.lang.Integer IS_VIEWPORT_AREA
The is-viewport-area trait.

BLINK

public static final java.lang.Integer BLINK
Blinking trait used when rendering inline parent.

UNDERLINE_COLOR

public static final java.lang.Integer UNDERLINE_COLOR
Trait for color of underline decorations when rendering inline parent.

OVERLINE_COLOR

public static final java.lang.Integer OVERLINE_COLOR
Trait for color of overline decorations when rendering inline parent.

LINETHROUGH_COLOR

public static final java.lang.Integer LINETHROUGH_COLOR
Trait for color of linethrough decorations when rendering inline parent.
Constructor Detail

Trait

public Trait()
Create a new empty trait.

Trait

public Trait(java.lang.Object propType,
             java.lang.Object data)
Create a trait with the value and type.
Parameters:
propType - the type of trait
data - the data value
Method Detail

getTraitName

public static java.lang.String getTraitName(java.lang.Object traitCode)
Get the trait name for a trait code.
Parameters:
traitCode - the trait code to get the name for
Returns:
the trait name

getTraitCode

public static java.lang.Object getTraitCode(java.lang.String sTraitName)
Get the trait code for a trait name.
Parameters:
sTraitName - the name of the trait to find
Returns:
the trait code object

getData

public java.lang.Object getData()
Returns the trait data value.
Returns:
the trait data value

getPropType

public java.lang.Object getPropType()
Returns the property type.
Returns:
the property type

toString

public java.lang.String toString()
Return the string for debugging.
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

makeTraitValue

public static java.lang.Object makeTraitValue(java.lang.Object oCode,
                                              java.lang.String sTraitValue)
Make a trait value.
Parameters:
oCode - trait code
sTraitValue - trait value as String
Returns:
the trait value as object

fop 0.91beta

Copyright 1999-2005 The Apache Software Foundation. All Rights Reserved.