org.apache.fop.pdf

Class PDFGState

Implemented Interfaces:
PDFWritable

public class PDFGState
extends PDFObject

Class representing a /ExtGState object.

Field Summary

static PDFGState
DEFAULT
Default GState object
static String
GSTATE_ALPHA_NONSTROKE
Nonstroking Alpha (ca, PDF 1.4)
static String
GSTATE_ALPHA_SOURCE_FLAG
Alpha Source Flag (AIS, PDF 1.4)
static String
GSTATE_ALPHA_STROKE
Stroking Alpha (CA, PDF 1.4)
static String
GSTATE_BLACK_GENERATION
Black generation (BG)
static String
GSTATE_BLACK_GENERATION2
Black generation with default (BG2)
static String
GSTATE_BLEND_MODE
Blend mode (BM, PDF 1.4)
static String
GSTATE_DASH_PATTERN
Dash pattern (D)
static String
GSTATE_FLATNESS
Flatness (FL)
static String
GSTATE_FONT
Font (Font)
static String
GSTATE_HALFTONE_DICT
Halftone dictionary or stream (HT)
static String
GSTATE_HALFTONE_PHASE
Halftone phase (HTP, does not show up anymore in PDF 1.4)
static String
GSTATE_LINE_CAP
Line cap (LC)
static String
GSTATE_LINE_JOIN
Line join (LJ)
static String
GSTATE_LINE_WIDTH
Line width (LW)
static String
GSTATE_MITER_LIMIT
Miter limit (ML)
static String
GSTATE_OVERPRINT_FILL
Overprint for fill (op)
static String
GSTATE_OVERPRINT_MODE
Overprint mode (OPM)
static String
GSTATE_OVERPRINT_STROKE
Overprint for stroke (OP)
static String
GSTATE_RENDERING_INTENT
Rendering intent (RI)
static String
GSTATE_SMOOTHNESS
Smoothness (SM)
static String
GSTATE_SOFT_MASK
Soft mask (SMask, PDF 1.4)
static String
GSTATE_STRIKE_ADJ
Strike adjustment (SA)
static String
GSTATE_TEXT_KNOCKOUT
Text Knockout Flag (TK, PDF 1.4)
static String
GSTATE_TRANSFER_FUNCTION
Transfer function (TR)
static String
GSTATE_TRANSFER_FUNCTION2
Transfer function with default (TR2)
static String
GSTATE_UNDERCOLOR_REMOVAL
Undercolor removal function (UCR)
static String
GSTATE_UNDERCOLOR_REMOVAL2
Undercolor removal function with default (UCR2)

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Method Summary

void
addValues(Map vals)
Adds all values from a Map to this object.
void
addValues(PDFGState state)
Adds all values from another GState object to this one.
boolean
equals(Object obj)
String
getName()
Returns the name of this object
void
setAlpha(float val, boolean fill)
Sets the alpha value.
String
toPDFString()

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString

Field Details

DEFAULT

public static final PDFGState DEFAULT
Default GState object

GSTATE_ALPHA_NONSTROKE

public static final String GSTATE_ALPHA_NONSTROKE
Nonstroking Alpha (ca, PDF 1.4)

GSTATE_ALPHA_SOURCE_FLAG

public static final String GSTATE_ALPHA_SOURCE_FLAG
Alpha Source Flag (AIS, PDF 1.4)

GSTATE_ALPHA_STROKE

public static final String GSTATE_ALPHA_STROKE
Stroking Alpha (CA, PDF 1.4)

GSTATE_BLACK_GENERATION

public static final String GSTATE_BLACK_GENERATION
Black generation (BG)

GSTATE_BLACK_GENERATION2

public static final String GSTATE_BLACK_GENERATION2
Black generation with default (BG2)

GSTATE_BLEND_MODE

public static final String GSTATE_BLEND_MODE
Blend mode (BM, PDF 1.4)

GSTATE_DASH_PATTERN

public static final String GSTATE_DASH_PATTERN
Dash pattern (D)

GSTATE_FLATNESS

public static final String GSTATE_FLATNESS
Flatness (FL)

GSTATE_FONT

public static final String GSTATE_FONT
Font (Font)

GSTATE_HALFTONE_DICT

public static final String GSTATE_HALFTONE_DICT
Halftone dictionary or stream (HT)

GSTATE_HALFTONE_PHASE

public static final String GSTATE_HALFTONE_PHASE
Halftone phase (HTP, does not show up anymore in PDF 1.4)

GSTATE_LINE_CAP

public static final String GSTATE_LINE_CAP
Line cap (LC)

GSTATE_LINE_JOIN

public static final String GSTATE_LINE_JOIN
Line join (LJ)

GSTATE_LINE_WIDTH

public static final String GSTATE_LINE_WIDTH
Line width (LW)

GSTATE_MITER_LIMIT

public static final String GSTATE_MITER_LIMIT
Miter limit (ML)

GSTATE_OVERPRINT_FILL

public static final String GSTATE_OVERPRINT_FILL
Overprint for fill (op)

GSTATE_OVERPRINT_MODE

public static final String GSTATE_OVERPRINT_MODE
Overprint mode (OPM)

GSTATE_OVERPRINT_STROKE

public static final String GSTATE_OVERPRINT_STROKE
Overprint for stroke (OP)

GSTATE_RENDERING_INTENT

public static final String GSTATE_RENDERING_INTENT
Rendering intent (RI)

GSTATE_SMOOTHNESS

public static final String GSTATE_SMOOTHNESS
Smoothness (SM)

GSTATE_SOFT_MASK

public static final String GSTATE_SOFT_MASK
Soft mask (SMask, PDF 1.4)

GSTATE_STRIKE_ADJ

public static final String GSTATE_STRIKE_ADJ
Strike adjustment (SA)

GSTATE_TEXT_KNOCKOUT

public static final String GSTATE_TEXT_KNOCKOUT
Text Knockout Flag (TK, PDF 1.4)

GSTATE_TRANSFER_FUNCTION

public static final String GSTATE_TRANSFER_FUNCTION
Transfer function (TR)

GSTATE_TRANSFER_FUNCTION2

public static final String GSTATE_TRANSFER_FUNCTION2
Transfer function with default (TR2)

GSTATE_UNDERCOLOR_REMOVAL

public static final String GSTATE_UNDERCOLOR_REMOVAL
Undercolor removal function (UCR)

GSTATE_UNDERCOLOR_REMOVAL2

public static final String GSTATE_UNDERCOLOR_REMOVAL2
Undercolor removal function with default (UCR2)

Method Details

addValues

public void addValues(Map vals)
Adds all values from a Map to this object.
Parameters:
vals - source object to copy from

addValues

public void addValues(PDFGState state)
Adds all values from another GState object to this one.
Parameters:
state - source object to copy from

equals

public boolean equals(Object obj)
See Also:
java.lang.Object.equals(Object)

getName

public String getName()
Returns the name of this object
Returns:
the name

setAlpha

public void setAlpha(float val,
                     boolean fill)
Sets the alpha value.
Parameters:
val - alpha value (0.0 - 1.0)
fill - True if alpha should be set for non-stroking operations, False if for stroking operations

toPDFString

public String toPDFString()
Overrides:
toPDFString in interface PDFObject

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