Packageorg.purepdf.pdf
Classpublic class PdfAppearance
InheritancePdfAppearance Inheritance PdfTemplate Inheritance PdfContentByte Inheritance it.sephiroth.utils.ObjectHash



Public Properties
 PropertyDefined By
 InheritedboundingBox : RectangleElement
PdfTemplate
 Inheritedgroup : PdfTransparencyGroup
PdfTemplate
 Inheritedheight : Number
PdfTemplate
 InheritedindirectReference : PdfIndirectReference
[read-only]
PdfTemplate
 Inheritedlayer : IPdfOCG
PdfTemplate
 Inheritedmatrix : PdfArray
[read-only]
PdfTemplate
 InheritedpageResources : PageResources
[override]
PdfTemplate
 InheritedpdfDocument : PdfDocument
[read-only]
PdfContentByte
 Inheritedresources : PdfObject
[read-only] Constructs the resources used by this template.
PdfTemplate
 Inheritedsize : uint
[read-only]
PdfContentByte
  _stdFieldFontNames : HashMap
[static]
PdfAppearance
  stdFieldFontNames : HashMap
[static] [read-only]
PdfAppearance
 Inheritedtype : int
[read-only]
PdfTemplate
 Inheritedwidth : Number
PdfTemplate
 Inheritedwriter : PdfWriter
PdfContentByte
 InheritedxTLM : Number
[read-only] Get the x position of the text line matrix.
PdfContentByte
 InheritedyTLM : Number
[read-only] Get the y position of the text line matrix
PdfContentByte
Protected Properties
 PropertyDefined By
 InheritedbBox : RectangleElement
PdfTemplate
 Inheritedcontent : ByteBuffer
PdfContentByte
 Inherited_group : PdfTransparencyGroup
PdfTemplate
 InheritedinText : Boolean = false
PdfContentByte
 InheritedlayerDepth : Vector.<int>
PdfContentByte
 Inherited_matrix : PdfArray
PdfTemplate
 InheritedmcDepth : int = 0
PdfContentByte
 Inherited_pageResources : PageResources
PdfTemplate
 Inheritedpdf : PdfDocument
PdfContentByte
 Inheritedseparator : int
PdfContentByte
 Inheritedstate : GraphicState
PdfContentByte
 InheritedstateList : Vector.<GraphicState>
PdfContentByte
 InheritedthisReference : PdfIndirectReference
PdfTemplate
 Inherited_type : int
PdfTemplate
 Inherited_writer : PdfWriter
PdfContentByte
Public Methods
 MethodDefined By
  
PdfAppearance($writer:PdfWriter = null)
PdfAppearance
 Inherited
add(other:PdfContentByte):void
Adds the content of another PdfContent object to this object.
PdfContentByte
 Inherited
PdfContentByte
 Inherited
PdfContentByte
 Inherited
Adds an ImageElement to the page.
PdfContentByte
 Inherited
addImage1(image:ImageElement, inlineImage:Boolean):void
Adds an ImageElement to the page.
PdfContentByte
 Inherited
addImage2(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number, inlineImage:Boolean):void
Adds an ImageElement to the page.
PdfContentByte
 Inherited
addImage3(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number):void
Adds an ImageElement to the page.
PdfContentByte
 Inherited
addTemplate(template:PdfTemplate, a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, tx:Number = 0, ty:Number = 0):void
Adds a template to this content
PdfContentByte
 Inherited
addTemplateReference(template:PdfIndirectReference, name:PdfName, a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):void
PdfContentByte
 Inherited
arc(x1:Number, y1:Number, x2:Number, y2:Number, startAng:Number, extent:Number):void
Draws a partial ellipse inscribed within the rectangle x1,y1,x2,y2, starting at startAng degrees and covering extent degrees.
PdfContentByte
 Inherited
beginLayer(layer:IPdfOCG):void
Begins a graphic block whose visibility is controlled by the layer.
PdfContentByte
 Inherited
Begins a marked content sequence.
PdfContentByte
 Inherited
beginMarkedContentSequence2(tag:PdfName, property:PdfDictionary, inline:Boolean):void
Begins a marked content sequence.
PdfContentByte
 Inherited
This is just a shorthand to beginMarkedContentSequence2
PdfContentByte
 Inherited
beginText():void
start writing text
PdfContentByte
 Inherited
PdfTemplate
 Inherited
bezierArc(x1:Number, y1:Number, x2:Number, y2:Number, startAng:Number, extent:Number):Vector.<Vector.<Number>>
[static] Generates an array of bezier curves to draw an arc.
PdfContentByte
 Inherited
Check if the template is a pattern.
PdfContentByte
 Inherited
circle(x:Number, y:Number, r:Number):void
Draws a circle.
PdfContentByte
 Inherited
clip(even_odd:Boolean = false):void
Modify the current clipping path by intersecting it with the current path, using the even_odd winding number rule to determine which regions lie inside the clipping path.
PdfContentByte
 Inherited
closePath():void
Closes the current subpath by appending a straight line segment from the current point to the starting point of the subpath.
PdfContentByte
 Inherited
closePathFillStroke(even_odd:Boolean = false):void
Closes the path, fills it using the even_odd winding number rule to determine the region to fill and strokes it.
PdfContentByte
 Inherited
Closes the path and strokes it.
PdfContentByte
 Inherited
concatCTM(a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):void
Concatenate a matrix to the current matrix.
PdfContentByte
 Inherited
concatMatrix(matrix:Matrix):void
Concatenate a matrix to the current matrix.
PdfContentByte
  
createAppearance(writer:PdfWriter, width:Number, height:Number):PdfAppearance
[static]
PdfAppearance
 Inherited
createPattern(width:Number, height:Number, xstep:Number, ystep:Number):PdfPatternPainter
Create a new colored tiling pattern.
PdfContentByte
 Inherited
createPatternColor(width:Number, height:Number, xstep:Number, ystep:Number, color:RGBColor):PdfPatternPainter
Create a new uncolored tiling pattern.
PdfContentByte
 Inherited
createTemplate(writer:PdfWriter, w:Number, h:Number):PdfTemplate
[static] Creates a new template Creates a new template that is nothing more than a form XObject
PdfTemplate
 Inherited
createTemplate2(writer:PdfWriter, w:Number, h:Number, forcedName:PdfName):PdfTemplate
[static]
PdfTemplate
 Inherited
curveTo(x1:Number, y1:Number, x2:Number, y2:Number, x3:Number, y3:Number):void
Appends a Bezier curve to the path, starting from the current point.
PdfContentByte
  
[override]
PdfAppearance
 Inherited
ellipse(x1:Number, y1:Number, x2:Number, y2:Number):void
Draws an ellipse inscribed within the rectangle x1,y1,x2,y2.
PdfContentByte
 Inherited
endLayer():void
PdfContentByte
 Inherited
Ends a marked content sequence
PdfContentByte
 Inherited
endText():void
PdfContentByte
 Inherited
PdfTemplate
 Inherited
[static]
PdfContentByte
 Inherited
[static]
PdfContentByte
 Inherited
fill(even_odd:Boolean = false):void
fill the path
PdfContentByte
 Inherited
fillStroke(even_odd:Boolean = false):void
Fills the path using the even_odd winding number rule to determine the region to fill and strokes it.
PdfContentByte
 Inherited
Get the current character spacing
PdfContentByte
 Inherited
getEffectiveStringWidth(text:String, kerned:Boolean = false):Number
Computes the width of the given string taking in account the current values of "Character spacing", "Word Spacing" and "Horizontal Scaling"
PdfContentByte
 Inherited
getFormXObject(compressionLevel:int):PdfStream
Gets the stream representing this template.
PdfTemplate
 Inherited
Return the internal buffer
PdfContentByte
 Inherited
[static] Constructs a kern array for a text in a certain font
PdfContentByte
 Inherited
lineTo(x:Number, y:Number):void
PdfContentByte
 Inherited
moveText(x:Number, y:Number):void
Moves to the start of the next line, offset from the start of the current line.
PdfContentByte
 Inherited
moveTo(x:Number, y:Number):void
Move the current point omitting any connecting line segment.
PdfContentByte
 Inherited
newlineShowText(text:String):void
Moves to the next line and shows text
PdfContentByte
 Inherited
newPath():void
Ends the path without filling or stroking it.
PdfContentByte
 Inherited
Paint using a shading object
PdfContentByte
 Inherited
Paints using a shading pattern.
PdfContentByte
 Inherited
rectangle(... params):void
Adds a rectangle to the current path Either a RectangleElement or 4 Numbers are accepted as parameters. Example: cb.setFillColor( RGBColor.BLACK ); cb.rectangle( 0, 0, 100, 100 ); cb.fill(); var rect: RectangleElement = new RectangleElement( 0, 0, 100, 100 ); rect.setBorderSides( RectangleElement.ALL ); rect.setBorderWidth(5); rect.setBackgroundColor( RGBColor.RED ); cb.rectangle( rect );
PdfContentByte
 Inherited
reset(value:Boolean = true):void
Makes this PdfContentByte empty.
PdfContentByte
 Inherited
resetFill():void
PdfContentByte
 Inherited
PdfContentByte
 Inherited
Restores the graphic state.
PdfContentByte
 Inherited
roundRectangle(x:Number, y:Number, w:Number, h:Number, r:Number):void
Adds a round rectangle to the current path.
PdfContentByte
 Inherited
saveState():void
Saves the graphic state.
PdfContentByte
 Inherited
setCharacterSpacing(charSpace:Number):void
Change the character spacing
PdfContentByte
 Inherited
setCMYKFillColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void
Changes the current color for filling paths (device dependent colors!).
PdfContentByte
 Inherited
setCMYKStrokeColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void
Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for stroking paths. Each value must be between 0 and 1.
PdfContentByte
 Inherited
Sets the fill color
PdfContentByte
 Inherited
PdfContentByte
 Inherited
setFillColor(value:uint):void
Changes the current color for filling paths Sets the color space to DeviceRGB
PdfContentByte
  
setFontAndSize(bf:BaseFont, size:Number):void
[override]
PdfAppearance
 Inherited
setGrayFill(gray:Number):void
PdfContentByte
 Inherited
setGrayStroke(gray:Number):void
PdfContentByte
 Inherited
setGState(gstate:PdfGState):void
Apply the graphic state
PdfContentByte
 Inherited
setLeading(value:Number):void
Sets the text leading parameter.
PdfContentByte
 Inherited
setLineCap(style:int):void
Changes the Line cap style The line cap style specifies the shape to be used at the end of open subpaths when they are stroked.
PdfContentByte
 Inherited
setLineDash(phase:Number):void
Changes the value of the line dash pattern.
PdfContentByte
 Inherited
setLineDash2(unitsOn:Number, phase:Number):void
Changes the value of the line dash pattern. The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
PdfContentByte
 Inherited
setLineDash3(unitsOn:Number, unitsOff:Number, phase:Number):void
Changes the value of the line dash pattern The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
PdfContentByte
 Inherited
setLineDash4(array:Vector.<Number>, phase:Number):void
Changes the value of the line dash pattern The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
PdfContentByte
 Inherited
setLineJoin(joint:String):void
Changes the Line join style The line join style specifies the shape to be used at the corners of paths that are stroked. Allowed values are JointStyle.MITER (Miter joins), JointStyle.ROUND (Round joins) and JointStyle.BEVEL (Bevel joins).
PdfContentByte
 Inherited
setLineWidth(w:Number):void
Changes the line width.
PdfContentByte
 Inherited
setLiteral(value:String):void
Output a String directly to the content
PdfContentByte
 Inherited
setMatrix(value:Matrix):void
PdfTemplate
 Inherited
setMatrixValues(a:Number, b:Number, c:Number, d:Number, tx:Number, ty:Number):void
PdfTemplate
 Inherited
setMiterLimit(miterLimit:Number):void
Changes the Miter limit.
PdfContentByte
 Inherited
Set the fill color to a pattern
PdfContentByte
 Inherited
Set the fill color of an uncolored pattern
PdfContentByte
 Inherited
setPatternFill3(p:PdfPatternPainter, color:RGBColor, tint:Number):void
Set the fill color to an uncolored pattern
PdfContentByte
 Inherited
Sets the stroke color to a pattern
PdfContentByte
 Inherited
Sets the stroke color to an uncolored pattern
PdfContentByte
 Inherited
setPatternStroke3(p:PdfPatternPainter, color:RGBColor, tint:Number):void
Sets the stroke color to an uncolored pattern
PdfContentByte
 Inherited
setRGBFillColor(red:int, green:int, blue:int):void
Changes the current color for filling paths Sets the color space to DeviceRGB
PdfContentByte
 Inherited
setRGBStrokeColor(red:int, green:int, blue:int):void
PdfContentByte
 Inherited
Sets the shading fill pattern.
PdfContentByte
 Inherited
Sets the shading stroke pattern
PdfContentByte
 Inherited
setSpotFillColor(sp:PdfSpotColor, tint:Number):void
Sets the fill color to a spot color.
PdfContentByte
 Inherited
setSpotStrokeColor(sp:PdfSpotColor, tint:Number):void
Sets the stroke color to a spot color
PdfContentByte
 Inherited
setStrokeColor(value:uint):void
PdfContentByte
 Inherited
setTextMatrix(a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, x:Number = 0, y:Number = 0):void
Change the text matrix
PdfContentByte
 Inherited
setTextRenderingMode(rendering:int):void
Sets the text rendering mode
PdfContentByte
 Inherited
setTextRise(rise:Number):void
This allows to write text in subscript or superscript mode
PdfContentByte
 Inherited
setTransform(m:Matrix):void
Concatenates the transformation to the current matrix
PdfContentByte
 Inherited
setWordSpacing(wordSpace:Number):void
Change the word spacing
PdfContentByte
 Inherited
showText(text:String):void
Shows the text
PdfContentByte
 Inherited
showTextAligned(alignment:int, text:String, x:Number, y:Number, rotation:Number, kerned:Boolean = false):void
Shows text aligned (left, center or right) with rotation.
PdfContentByte
 Inherited
Show an array of kerned text
PdfContentByte
 Inherited
showTextKerned(text:String):void
Shows the text kerned
PdfContentByte
 Inherited
stroke():void
Strokes the path.
PdfContentByte
 Inherited
PdfContentByte
 Inherited
toString():String
PdfContentByte
 Inherited
Adds a variable width border to the current path.
PdfContentByte
Protected Methods
 MethodDefined By
 Inherited
PdfContentByte
 Inherited
Checks for any error in mismatched save/restore state, begin/end text, begin/end layer, or begin/end marked content sequence.
PdfContentByte
Public Constants
 ConstantDefined By
 InheritedALIGN_CENTER : int = 1
[static]
PdfContentByte
 InheritedALIGN_LEFT : int = 0
[static]
PdfContentByte
 InheritedALIGN_RIGHT : int = 2
[static]
PdfContentByte
 InheritedLINE_CAP_BUTT : int = 0
[static]
PdfContentByte
 InheritedLINE_CAP_PROJECTING_SQUARE : int = 2
[static]
PdfContentByte
 InheritedLINE_CAP_ROUND : int = 1
[static]
PdfContentByte
 InheritedLINE_JOIN_BEVEL : int = 2
[static]
PdfContentByte
 InheritedLINE_JOIN_MITER : int = 0
[static]
PdfContentByte
 InheritedLINE_JOIN_ROUND : int = 1
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_CLIP : int = 7
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_FILL : int = 0
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_FILL_CLIP : int = 4
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_FILL_STROKE : int = 2
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_FILL_STROKE_CLIP : int = 6
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_INVISIBLE : int = 3
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_STROKE : int = 1
[static]
PdfContentByte
 InheritedTEXT_RENDER_MODE_STROKE_CLIP : int = 5
[static]
PdfContentByte
 InheritedTYPE_IMPORTED : int = 2
[static]
PdfTemplate
 InheritedTYPE_PATTERN : int = 3
[static]
PdfTemplate
 InheritedTYPE_TEMPLATE : int = 1
[static]
PdfTemplate
Property Detail
_stdFieldFontNamesproperty
public static var _stdFieldFontNames:HashMap

stdFieldFontNamesproperty 
stdFieldFontNames:HashMap  [read-only]


Implementation
    public static function get stdFieldFontNames():HashMap
Constructor Detail
PdfAppearance()Constructor
public function PdfAppearance($writer:PdfWriter = null)



Parameters
$writer:PdfWriter (default = null)
Method Detail
createAppearance()method
public static function createAppearance(writer:PdfWriter, width:Number, height:Number):PdfAppearance

Parameters

writer:PdfWriter
 
width:Number
 
height:Number

Returns
PdfAppearance
duplicate()method 
override public function duplicate():PdfContentByte

Returns
PdfContentByte
setFontAndSize()method 
override public function setFontAndSize(bf:BaseFont, size:Number):void

Parameters

bf:BaseFont
 
size:Number