org.purepdf.pdf.PdfPatternPainter

	Property	Defined By
		boundingBox : RectangleElement	PdfTemplate
		defaultColor : RGBColor [read-only]	PdfPatternPainter
		group : PdfTransparencyGroup	PdfTemplate
		height : Number	PdfTemplate
		indirectReference : PdfIndirectReference [read-only]	PdfTemplate
		is_stencil : Boolean [read-only] Tells you if this pattern is colored/uncolored	PdfPatternPainter
		layer : IPdfOCG	PdfTemplate
		matrix : PdfArray [read-only]	PdfTemplate
		pageResources : PageResources [override]	PdfTemplate
		pdfDocument : PdfDocument [read-only]	PdfContentByte
		resources : PdfObject [read-only] Constructs the resources used by this template.	PdfTemplate
		size : uint [read-only]	PdfContentByte
		type : int [read-only]	PdfTemplate
		width : Number	PdfTemplate
		writer : PdfWriter	PdfContentByte
		xstep : Number Set the horizontal interval of this pattern	PdfPatternPainter
		xTLM : Number [read-only] Get the x position of the text line matrix.	PdfContentByte
		ystep : Number Get the vertical interval of this pattern.	PdfPatternPainter
		yTLM : Number [read-only] Get the y position of the text line matrix	PdfContentByte

	Property	Defined By
		bBox : RectangleElement	PdfTemplate
		content : ByteBuffer	PdfContentByte
		_group : PdfTransparencyGroup	PdfTemplate
		inText : Boolean = false	PdfContentByte
		layerDepth : Vector.<int>	PdfContentByte
		_matrix : PdfArray	PdfTemplate
		mcDepth : int = 0	PdfContentByte
		_pageResources : PageResources	PdfTemplate
		pdf : PdfDocument	PdfContentByte
		separator : int	PdfContentByte
		state : GraphicState	PdfContentByte
		stateList : Vector.<GraphicState>	PdfContentByte
		thisReference : PdfIndirectReference	PdfTemplate
		_type : int	PdfTemplate
		_writer : PdfWriter	PdfContentByte

Public Methods

	Method		Defined By
		PdfPatternPainter($writer:PdfWriter = null, color:RGBColor = null)	PdfPatternPainter
		add(other:PdfContentByte):void Adds the content of another PdfContent object to this object.	PdfContentByte
		addAnnotation(annot:PdfAnnotation):void	PdfContentByte
		addContent(other:PdfContentByte):void	PdfContentByte
		addImage(image:ImageElement):void Adds an ImageElement to the page.	PdfContentByte
		addImage1(image:ImageElement, inlineImage:Boolean):void Adds an ImageElement to the page.	PdfContentByte
		addImage2(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number, inlineImage:Boolean):void [override]	PdfPatternPainter
		addImage3(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number):void Adds an ImageElement to the page.	PdfContentByte
		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
		addTemplateReference(template:PdfIndirectReference, name:PdfName, a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):void	PdfContentByte
		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
		beginLayer(layer:IPdfOCG):void Begins a graphic block whose visibility is controlled by the layer.	PdfContentByte
		beginMarkedContentSequence(struc:PdfStructureElement):void Begins a marked content sequence.	PdfContentByte
		beginMarkedContentSequence2(tag:PdfName, property:PdfDictionary, inline:Boolean):void Begins a marked content sequence.	PdfContentByte
		beginMarkedContentSequence3(tag:PdfName):void This is just a shorthand to beginMarkedContentSequence2	PdfContentByte
		beginText():void start writing text	PdfContentByte
		beginVariableText():void	PdfTemplate
		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
		checkNoColor():void	PdfPatternPainter
		checkNoPattern(t:PdfTemplate):void Check if the template is a pattern.	PdfContentByte
		circle(x:Number, y:Number, r:Number):void Draws a circle.	PdfContentByte
		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
		closePath():void Closes the current subpath by appending a straight line segment from the current point to the starting point of the subpath.	PdfContentByte
		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
		closePathStroke():void Closes the path and strokes it.	PdfContentByte
		concatCTM(a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):void Concatenate a matrix to the current matrix.	PdfContentByte
		concatMatrix(matrix:Matrix):void Concatenate a matrix to the current matrix.	PdfContentByte
		createAppearance(width:Number, height:Number):PdfAppearance	PdfContentByte
		createPattern(width:Number, height:Number, xstep:Number, ystep:Number):PdfPatternPainter Create a new colored tiling pattern.	PdfContentByte
		createPatternColor(width:Number, height:Number, xstep:Number, ystep:Number, color:RGBColor):PdfPatternPainter Create a new uncolored tiling pattern.	PdfContentByte
		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
		createTemplate2(writer:PdfWriter, w:Number, h:Number, forcedName:PdfName):PdfTemplate [static]	PdfTemplate
		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
		duplicate():PdfContentByte [override]	PdfPatternPainter
		ellipse(x1:Number, y1:Number, x2:Number, y2:Number):void Draws an ellipse inscribed within the rectangle x1,y1,x2,y2.	PdfContentByte
		endLayer():void	PdfContentByte
		endMarkedContentSequence():void Ends a marked content sequence	PdfContentByte
		endText():void	PdfContentByte
		endVariableText():void	PdfTemplate
		escapeByteArray(byte:Bytes):Bytes [static]	PdfContentByte
		escapeString(byte:Bytes, content:ByteBuffer):ByteBuffer [static]	PdfContentByte
		fill(even_odd:Boolean = false):void fill the path	PdfContentByte
		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
		getCharacterSpacing():Number Get the current character spacing	PdfContentByte
		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
		getFormXObject(compressionLevel:int):PdfStream Gets the stream representing this template.	PdfTemplate
		getInternalBuffer():ByteBuffer Return the internal buffer	PdfContentByte
		getKernArray(text:String, font:BaseFont):PdfTextArray [static] Constructs a kern array for a text in a certain font	PdfContentByte
		getPattern(compressionLvl:int = 0):PdfPattern Get the stream for this pattern	PdfPatternPainter
		lineTo(x:Number, y:Number):void	PdfContentByte
		moveText(x:Number, y:Number):void Moves to the start of the next line, offset from the start of the current line.	PdfContentByte
		moveTo(x:Number, y:Number):void Move the current point omitting any connecting line segment.	PdfContentByte
		newlineShowText(text:String):void Moves to the next line and shows text	PdfContentByte
		newPath():void Ends the path without filling or stroking it.	PdfContentByte
		paintShading(value:PdfShading):void Paint using a shading object	PdfContentByte
		paintShadingPattern(shading:PdfShadingPattern):void Paints using a shading pattern.	PdfContentByte
		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
		reset(value:Boolean = true):void Makes this PdfContentByte empty.	PdfContentByte
		resetFill():void [override]	PdfPatternPainter
		resetStroke():void [override]	PdfPatternPainter
		restoreState():void Restores the graphic state.	PdfContentByte
		roundRectangle(x:Number, y:Number, w:Number, h:Number, r:Number):void Adds a round rectangle to the current path.	PdfContentByte
		saveState():void Saves the graphic state.	PdfContentByte
		setCharacterSpacing(charSpace:Number):void Change the character spacing	PdfContentByte
		setCMYKFillColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void [override]	PdfPatternPainter
		setCMYKStrokeColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void [override]	PdfPatternPainter
		setColorFill(color:RGBColor):void [override]	PdfPatternPainter
		setColorStroke(color:RGBColor):void [override]	PdfPatternPainter
		setFillColor(value:uint):void Changes the current color for filling paths Sets the color space to DeviceRGB	PdfContentByte
		setFontAndSize(bf:BaseFont, size:Number):void Set the font and the size for the subsequent text writing	PdfContentByte
		setGrayFill(gray:Number):void [override]	PdfPatternPainter
		setGrayStroke(gray:Number):void [override]	PdfPatternPainter
		setGState(gstate:PdfGState):void Apply the graphic state	PdfContentByte
		setLeading(value:Number):void Sets the text leading parameter.	PdfContentByte
		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
		setLineDash(phase:Number):void Changes the value of the line dash pattern.	PdfContentByte
		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
		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
		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
		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
		setLineWidth(w:Number):void Changes the line width.	PdfContentByte
		setLiteral(value:String):void Output a String directly to the content	PdfContentByte
		setMatrix(value:Matrix):void	PdfTemplate
		setMatrixValues(a:Number, b:Number, c:Number, d:Number, tx:Number, ty:Number):void	PdfTemplate
		setMiterLimit(miterLimit:Number):void Changes the Miter limit.	PdfContentByte
		setPatternFill(p:PdfPatternPainter):void [override]	PdfPatternPainter
		setPatternFill2(p:PdfPatternPainter, color:RGBColor):void [override]	PdfPatternPainter
		setPatternFill3(p:PdfPatternPainter, color:RGBColor, tint:Number):void [override]	PdfPatternPainter
		setPatternStroke(p:PdfPatternPainter):void [override]	PdfPatternPainter
		setPatternStroke2(p:PdfPatternPainter, color:RGBColor):void [override]	PdfPatternPainter
		setPatternStroke3(p:PdfPatternPainter, color:RGBColor, tint:Number):void [override]	PdfPatternPainter
		setRGBFillColor(red:int, green:int, blue:int):void [override]	PdfPatternPainter
		setRGBStrokeColor(red:int, green:int, blue:int):void [override]	PdfPatternPainter
		setShadingFill(shading:PdfShadingPattern):void Sets the shading fill pattern.	PdfContentByte
		setShadingStroke(shading:PdfShadingPattern):void Sets the shading stroke pattern	PdfContentByte
		setSpotFillColor(sp:PdfSpotColor, tint:Number):void Sets the fill color to a spot color.	PdfContentByte
		setSpotStrokeColor(sp:PdfSpotColor, tint:Number):void Sets the stroke color to a spot color	PdfContentByte
		setStrokeColor(value:uint):void	PdfContentByte
		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
		setTextRenderingMode(rendering:int):void Sets the text rendering mode	PdfContentByte
		setTextRise(rise:Number):void This allows to write text in subscript or superscript mode	PdfContentByte
		setTransform(m:Matrix):void Concatenates the transformation to the current matrix	PdfContentByte
		setWordSpacing(wordSpace:Number):void Change the word spacing	PdfContentByte
		showText(text:String):void Shows the text	PdfContentByte
		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
		showTextArray(text:PdfTextArray):void Show an array of kerned text	PdfContentByte
		showTextKerned(text:String):void Shows the text kerned	PdfContentByte
		stroke():void Strokes the path.	PdfContentByte
		toPdf($writer:PdfWriter):Bytes	PdfContentByte
		toString():String	PdfContentByte
		variableRectangle(rect:RectangleElement):void Adds a variable width border to the current path.	PdfContentByte

	Method	Defined By
		checkWriter():void	PdfContentByte
		sanityCheck():void Checks for any error in mismatched save/restore state, begin/end text, begin/end layer, or begin/end marked content sequence.	PdfContentByte

	Constant	Defined By
		ALIGN_CENTER : int = 1 [static]	PdfContentByte
		ALIGN_LEFT : int = 0 [static]	PdfContentByte
		ALIGN_RIGHT : int = 2 [static]	PdfContentByte
		LINE_CAP_BUTT : int = 0 [static]	PdfContentByte
		LINE_CAP_PROJECTING_SQUARE : int = 2 [static]	PdfContentByte
		LINE_CAP_ROUND : int = 1 [static]	PdfContentByte
		LINE_JOIN_BEVEL : int = 2 [static]	PdfContentByte
		LINE_JOIN_MITER : int = 0 [static]	PdfContentByte
		LINE_JOIN_ROUND : int = 1 [static]	PdfContentByte
		TEXT_RENDER_MODE_CLIP : int = 7 [static]	PdfContentByte
		TEXT_RENDER_MODE_FILL : int = 0 [static]	PdfContentByte
		TEXT_RENDER_MODE_FILL_CLIP : int = 4 [static]	PdfContentByte
		TEXT_RENDER_MODE_FILL_STROKE : int = 2 [static]	PdfContentByte
		TEXT_RENDER_MODE_FILL_STROKE_CLIP : int = 6 [static]	PdfContentByte
		TEXT_RENDER_MODE_INVISIBLE : int = 3 [static]	PdfContentByte
		TEXT_RENDER_MODE_STROKE : int = 1 [static]	PdfContentByte
		TEXT_RENDER_MODE_STROKE_CLIP : int = 5 [static]	PdfContentByte
		TYPE_IMPORTED : int = 2 [static]	PdfTemplate
		TYPE_PATTERN : int = 3 [static]	PdfTemplate
		TYPE_TEMPLATE : int = 1 [static]	PdfTemplate

Property Detail

defaultColor

property

defaultColor:RGBColor [read-only]

Implementation
public function get defaultColor():RGBColor

is_stencil

property

is_stencil:Boolean [read-only]

Tells you if this pattern is colored/uncolored

Implementation
public function get is_stencil():Boolean

xstep

property

xstep:Number

Set the horizontal interval of this pattern

Implementation
public function get xstep():Number
public function set xstep(value:Number):void

ystep

property

ystep:Number

Get the vertical interval of this pattern.

Implementation
public function get ystep():Number
public function set ystep(value:Number):void

Constructor Detail

PdfPatternPainter

()

Constructor

public function PdfPatternPainter($writer:PdfWriter = null, color:RGBColor = null)

Parameters

	`$writer:PdfWriter` (default = `null`)

	`color:RGBColor` (default = `null`)

Method Detail

addImage2

()

method

override public function addImage2(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number, inlineImage:Boolean):void

Parameters

	`image:ImageElement`

	`width:Number`

	`b:Number`

	`c:Number`

	`height:Number`

	`x:Number`

	`y:Number`

	`inlineImage:Boolean`

checkNoColor

()

method

public function checkNoColor():void

duplicate

()

method

override public function duplicate():PdfContentByte

Returns

PdfContentByte

getPattern

()

method

public function getPattern(compressionLvl:int = 0):PdfPattern

Get the stream for this pattern

Parameters

compressionLvl:int (default = 0)

Returns

PdfPattern

resetFill

()

method

override public function resetFill():void

resetStroke

()

method

override public function resetStroke():void

setCMYKFillColor

()

method

override public function setCMYKFillColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void

Parameters

	`cyan:Number`

	`magenta:Number`

	`yellow:Number`

	`black:Number`

setCMYKStrokeColor

()

method

override public function setCMYKStrokeColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void

Parameters

	`cyan:Number`

	`magenta:Number`

	`yellow:Number`

	`black:Number`

setColorFill

()

method

override public function setColorFill(color:RGBColor):void

Parameters

color:RGBColor

setColorStroke

()

method

override public function setColorStroke(color:RGBColor):void

Parameters

color:RGBColor

setGrayFill

()

method

override public function setGrayFill(gray:Number):void

Parameters

gray:Number

setGrayStroke

()

method

override public function setGrayStroke(gray:Number):void

Parameters

gray:Number

setPatternFill

()

method

override public function setPatternFill(p:PdfPatternPainter):void

Parameters

p:PdfPatternPainter

setPatternFill2

()

method

override public function setPatternFill2(p:PdfPatternPainter, color:RGBColor):void

Parameters

	`p:PdfPatternPainter`

	`color:RGBColor`

setPatternFill3

()

method

override public function setPatternFill3(p:PdfPatternPainter, color:RGBColor, tint:Number):void

Parameters

	`p:PdfPatternPainter`

	`color:RGBColor`

	`tint:Number`

setPatternStroke

()

method

override public function setPatternStroke(p:PdfPatternPainter):void

Parameters

p:PdfPatternPainter

setPatternStroke2

()

method

override public function setPatternStroke2(p:PdfPatternPainter, color:RGBColor):void

Parameters

	`p:PdfPatternPainter`

	`color:RGBColor`

setPatternStroke3

()

method

override public function setPatternStroke3(p:PdfPatternPainter, color:RGBColor, tint:Number):void

Parameters

	`p:PdfPatternPainter`

	`color:RGBColor`

	`tint:Number`

setRGBFillColor

()

method

override public function setRGBFillColor(red:int, green:int, blue:int):void

Parameters

	`red:int`

	`green:int`

	`blue:int`

setRGBStrokeColor

()

method

override public function setRGBStrokeColor(red:int, green:int, blue:int):void

Parameters

	`red:int`

	`green:int`

	`blue:int`

Thu May 27 2010, 07:51 AM +02:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PdfPatternPainter	Properties \| Methods \| Constants

Package	org.purepdf.pdf
Class	public class PdfPatternPainter
Inheritance	PdfPatternPainter PdfTemplate PdfContentByte it.sephiroth.utils.ObjectHash