| Package | org.purepdf.pdf |
| Class | public class PdfContentByte |
| Inheritance | PdfContentByte  it.sephiroth.utils.ObjectHash |
| Subclasses | PdfTemplate |
| Property | Defined By | ||
|---|---|---|---|
| pageResources : PageResources [read-only]
| PdfContentByte | ||
| pdfDocument : PdfDocument [read-only]
| PdfContentByte | ||
| size : uint [read-only]
| PdfContentByte | ||
| writer : PdfWriter | PdfContentByte | ||
| xTLM : Number [read-only]
Get the x position of the text line matrix. | PdfContentByte | ||
| yTLM : Number [read-only]
Get the y position of the text line matrix
| PdfContentByte | ||
| Property | Defined By | ||
|---|---|---|---|
| content : ByteBuffer | PdfContentByte | ||
| inText : Boolean = false | PdfContentByte | ||
| layerDepth : Vector.<int> | PdfContentByte | ||
| mcDepth : int = 0 | PdfContentByte | ||
| pdf : PdfDocument | PdfContentByte | ||
| separator : int | PdfContentByte | ||
| state : GraphicState | PdfContentByte | ||
| stateList : Vector.<GraphicState> | PdfContentByte | ||
| _writer : PdfWriter | PdfContentByte | ||
| Method | Defined By | ||
|---|---|---|---|
PdfContentByte($writer:PdfWriter) | PdfContentByte | ||
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
Adds an ImageElement to the page. | PdfContentByte | ||
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 | ||
Begins a marked content sequence. | PdfContentByte | ||
beginMarkedContentSequence3(tag:PdfName):void
This is just a shorthand to beginMarkedContentSequence2
| PdfContentByte | ||
beginText():void
start writing text
| PdfContentByte | ||
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 | ||
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 | ||
Creates a new template. | PdfContentByte | ||
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 | ||
| PdfContentByte | |||
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 | ||
[static]
| PdfContentByte | ||
[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 | ||
Return the internal buffer
| PdfContentByte | ||
[static]
Constructs a kern array for a text in a certain font
| PdfContentByte | ||
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 | PdfContentByte | ||
resetStroke():void | PdfContentByte | ||
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
Changes the current color for filling paths (device dependent colors!). | PdfContentByte | ||
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 | ||
setColorFill(color:RGBColor):void
Sets the fill color
| PdfContentByte | ||
setColorStroke(color:RGBColor):void | PdfContentByte | ||
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 | PdfContentByte | ||
setGrayStroke(gray:Number):void | PdfContentByte | ||
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 | ||
setMiterLimit(miterLimit:Number):void
Changes the Miter limit. | PdfContentByte | ||
setPatternFill(p:PdfPatternPainter):void
Set the fill color to a pattern
| PdfContentByte | ||
Set the fill color of an uncolored pattern
| PdfContentByte | ||
Set the fill color to an uncolored pattern
| PdfContentByte | ||
setPatternStroke(p:PdfPatternPainter):void
Sets the stroke color to a pattern
| PdfContentByte | ||
Sets the stroke color to an uncolored pattern
| PdfContentByte | ||
Sets the stroke color to an uncolored pattern
| PdfContentByte | ||
setRGBFillColor(red:int, green:int, blue:int):void
Changes the current color for filling paths
Sets the color space to DeviceRGB
| PdfContentByte | ||
setRGBStrokeColor(red:int, green:int, blue:int):void | PdfContentByte | ||
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 | ||
| 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 | ||
| _writer | property |
protected var _writer:PdfWriter| content | property |
protected var content:ByteBuffer| inText | property |
protected var inText:Boolean = false| layerDepth | property |
protected var layerDepth:Vector.<int>| mcDepth | property |
protected var mcDepth:int = 0| pageResources | property |
pageResources:PageResources [read-only]
public function get pageResources():PageResources| property |
protected var pdf:PdfDocument| pdfDocument | property |
| separator | property |
protected var separator:int| size | property |
size:uint [read-only]
public function get size():uint| state | property |
protected var state:GraphicState| stateList | property |
protected var stateList:Vector.<GraphicState>| writer | property |
writer:PdfWriter
public function get writer():PdfWriter public function set writer(value:PdfWriter):void| xTLM | property |
xTLM:Number [read-only] Get the x position of the text line matrix.
public function get xTLM():Number| yTLM | property |
yTLM:Number [read-only] Get the y position of the text line matrix
public function get yTLM():Number| PdfContentByte | () | Constructor |
| add | () | method |
public function add(other:PdfContentByte):voidAdds the content of another PdfContent object to this object.
Parameters
other:PdfContentByte |
| addAnnotation | () | method |
| addContent | () | method |
public function addContent(other:PdfContentByte):void
Parameters
other:PdfContentByte |
RuntimeError
|
| addImage | () | method |
public function addImage(image:ImageElement):void
Adds an ImageElement to the page. The ImageElement must have
absolute positioning.
Parameters
image:ImageElement — the ImageElement object
|
See also
| addImage1 | () | method |
public function addImage1(image:ImageElement, inlineImage:Boolean):void
Adds an ImageElement to the page. The ImageElement must have
absolute positioning. The image can be placed inline.
Parameters
image:ImageElement — the ImageElement object
| |
inlineImage:Boolean — true to place this image inline, false otherwise
|
See also
| addImage2 | () | method |
public function addImage2(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number, inlineImage:Boolean):void
Adds an ImageElement to the page. The positioning of the ImageElement
is done with the transformation matrix.
To position an ImageElement at (x,y)
use addImage(image, image_width, 0, 0, image_height, x, y)
Parameters
image:ImageElement — the ImageElement object
| |
width:Number | |
b:Number — element of the matrix
| |
c:Number — element of the matrix
| |
height:Number | |
x:Number | |
y:Number | |
inlineImage:Boolean |
See also
| addImage3 | () | method |
public function addImage3(image:ImageElement, width:Number, b:Number, c:Number, height:Number, x:Number, y:Number):void
Adds an ImageElement to the page. The positioning of the ImageElement
is done with the transformation matrix. To position an ImageElement at (x,y)
use addImage(image, image_width, 0, 0, image_height, x, y).
Parameters
image:ImageElement — the ImageElement object
| |
width:Number | |
b:Number — element of the transformation matrix
| |
c:Number — element of the transformation matrix
| |
height:Number | |
x:Number | |
y:Number |
See also
| addTemplate | () | method |
public function addTemplate(template:PdfTemplate, a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, tx:Number = 0, ty:Number = 0):voidAdds a template to this content
Parameters
template:PdfTemplate — the template
| |
a:Number (default = 1) | |
b:Number (default = 0) | |
c:Number (default = 0) | |
d:Number (default = 1) | |
tx:Number (default = 0) | |
ty:Number (default = 0) |
See also
| addTemplateReference | () | method |
public function addTemplateReference(template:PdfIndirectReference, name:PdfName, a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):voidParameters
template:PdfIndirectReference | |
name:PdfName | |
a:Number | |
b:Number | |
c:Number | |
d:Number | |
e:Number | |
f:Number |
| arc | () | method |
public function arc(x1:Number, y1:Number, x2:Number, y2:Number, startAng:Number, extent:Number):voidDraws a partial ellipse inscribed within the rectangle x1,y1,x2,y2, starting at startAng degrees and covering extent degrees. Angles start with 0 to the right (+x) and increase counter-clockwise.
Parameters
x1:Number — a corner of the enclosing rectangle
| |
y1:Number — a corner of the enclosing rectangle
| |
x2:Number — a corner of the enclosing rectangle
| |
y2:Number — a corner of the enclosing rectangle
| |
startAng:Number — starting angle in degrees
| |
extent:Number — angle extent in degrees
|
| beginLayer | () | method |
public function beginLayer(layer:IPdfOCG):void
Begins a graphic block whose visibility is controlled by the layer.
Blocks can be nested. Each block must be terminated by an {
Parameters
layer:IPdfOCG — the layer
|
ArgumentError
|
| beginMarkedContentSequence | () | method |
public function beginMarkedContentSequence(struc:PdfStructureElement):void| Since : | 0.22 |
Begins a marked content sequence. This sequence will be tagged with the structure struc.
The same structure can be used several times to connect text that belongs to the same logical segment
but is in a different location, like the same paragraph crossing to another page, for example.
Parameters
struc:PdfStructureElement |
IllegalOperationError
|
| beginMarkedContentSequence2 | () | method |
public function beginMarkedContentSequence2(tag:PdfName, property:PdfDictionary, inline:Boolean):voidBegins a marked content sequence. If property is null the mark will be of the type BMC otherwise it will be BDC.
Parameters
tag:PdfName — the tag
| |
property:PdfDictionary — the property
| |
inline:Boolean — true to include the property in the content or false
to include the property in the resource dictionary with the possibility of reusing
|
| beginMarkedContentSequence3 | () | method |
public function beginMarkedContentSequence3(tag:PdfName):voidThis is just a shorthand to beginMarkedContentSequence2
Parameters
tag:PdfName — the tag
|
| beginText | () | method |
public function beginText():voidstart writing text
| bezierArc | () | method |
public static function bezierArc(x1:Number, y1:Number, x2:Number, y2:Number, startAng:Number, extent:Number):Vector.<Vector.<Number>>Generates an array of bezier curves to draw an arc.
Parameters
x1:Number | |
y1:Number | |
x2:Number | |
y2:Number | |
startAng:Number — starting angle in degrees
| |
extent:Number — angle extent in degrees
|
Vector.<Vector.<Number>> |
| checkNoPattern | () | method |
public function checkNoPattern(t:PdfTemplate):voidCheck if the template is a pattern. In that case throws an Error c
Parameters
t:PdfTemplate |
RuntimeError
|
| checkWriter | () | method |
protected function checkWriter():void
| circle | () | method |
public function circle(x:Number, y:Number, r:Number):voidDraws a circle. The endpoint will (x+r, y).
Parameters
x:Number — x center of circle
| |
y:Number — y center of circle
| |
r:Number — radius of circle
|
| clip | () | method |
public function 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.
Parameters
even_odd:Boolean (default = false) |
| closePath | () | method |
public function closePath():voidCloses the current subpath by appending a straight line segment from the current point to the starting point of the subpath.
| closePathFillStroke | () | method |
public function 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.
Parameters
even_odd:Boolean (default = false) |
| closePathStroke | () | method |
public function closePathStroke():voidCloses the path and strokes it.
| concatCTM | () | method |
public function concatCTM(a:Number, b:Number, c:Number, d:Number, e:Number, f:Number):voidConcatenate a matrix to the current matrix.
Parameters
a:Number — an element of the matrix
| |
b:Number — an element of the matrix
| |
c:Number — an element of the matrix
| |
d:Number — an element of the matrix
| |
e:Number — an element of the matrix
| |
f:Number — an element of the matrix
|
| concatMatrix | () | method |
public function concatMatrix(matrix:Matrix):voidConcatenate a matrix to the current matrix.
Parameters
matrix:Matrix |
| createAppearance | () | method |
public function createAppearance(width:Number, height:Number):PdfAppearance
Parameters
width:Number | |
height:Number |
PdfAppearance —
|
| createPattern | () | method |
public function createPattern(width:Number, height:Number, xstep:Number, ystep:Number):PdfPatternPainterCreate a new colored tiling pattern.
Parameters
width:Number — the width of the pattern
| |
height:Number — the height of the pattern
| |
xstep:Number (default = NaN) | |
ystep:Number (default = NaN) |
PdfPatternPainter — the PdfPatternPainter where the pattern will be created
|
| createPatternColor | () | method |
public function createPatternColor(width:Number, height:Number, xstep:Number, ystep:Number, color:RGBColor):PdfPatternPainterCreate a new uncolored tiling pattern.
Parameters
width:Number — the width of the pattern
| |
height:Number — the height of the pattern
| |
xstep:Number — the desired horizontal spacing between pattern cells.
May be either positive or negative, but not zero.
| |
ystep:Number — the desired vertical spacing between pattern cells.
May be either positive or negative, but not zero.
| |
color:RGBColor — the default color. Can be null
|
PdfPatternPainter — the PdfPatternPainter where the pattern will be created
|
| createTemplate | () | method |
public function createTemplate(width:Number, height:Number, forcedName:PdfName = null):PdfTemplateCreates a new template. This template can be included in this PdfContentByte or in another template. Templates are written only when document is closed.
Parameters
width:Number | |
height:Number | |
forcedName:PdfName (default = null) |
PdfTemplate |
| curveTo | () | method |
public function curveTo(x1:Number, y1:Number, x2:Number, y2:Number, x3:Number, y3:Number):voidAppends a Bezier curve to the path, starting from the current point.
Parameters
x1:Number — x-coordinate of the first control point
| |
y1:Number — y-coordinate of the first control point
| |
x2:Number — x-coordinate of the second control point
| |
y2:Number — y-coordinate of the second control point
| |
x3:Number — x-coordinate of the ending point (= new current point)
| |
y3:Number — y-coordinate of the ending point (= new current point)
|
| duplicate | () | method |
| ellipse | () | method |
public function ellipse(x1:Number, y1:Number, x2:Number, y2:Number):voidDraws an ellipse inscribed within the rectangle x1,y1,x2,y2.
Parameters
x1:Number — a corner of the enclosing rectangle
| |
y1:Number — a corner of the enclosing rectangle
| |
x2:Number — a corner of the enclosing rectangle
| |
y2:Number — a corner of the enclosing rectangle
|
| endLayer | () | method |
public function endLayer():void
IllegalPdfSyntaxError
|
| endMarkedContentSequence | () | method |
public function endMarkedContentSequence():voidEnds a marked content sequence
| endText | () | method |
public function endText():void
IllegalPdfSyntaxError
|
| escapeByteArray | () | method |
| escapeString | () | method |
public static function escapeString(byte:Bytes, content:ByteBuffer):ByteBuffer
Parameters
byte:Bytes | |
content:ByteBuffer |
ByteBuffer —
|
| fill | () | method |
public function fill(even_odd:Boolean = false):voidfill the path
Parameters
even_odd:Boolean (default = false)even-odd winding rule or not. Default is false)
|
| fillStroke | () | method |
public function 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.
Parameters
even_odd:Boolean (default = false) |
| getCharacterSpacing | () | method |
public function getCharacterSpacing():NumberGet the current character spacing
ReturnsNumber |
| getEffectiveStringWidth | () | method |
public function getEffectiveStringWidth(text:String, kerned:Boolean = false):NumberComputes the width of the given string taking in account the current values of "Character spacing", "Word Spacing" and "Horizontal Scaling"
Parameters
text:String | |
kerned:Boolean (default = false) |
Number |
| getInternalBuffer | () | method |
| getKernArray | () | method |
public static function getKernArray(text:String, font:BaseFont):PdfTextArrayConstructs a kern array for a text in a certain font
Parameters
text:String — the text
| |
font:BaseFont — the font
|
PdfTextArray — a PdfTextArray
|
| lineTo | () | method |
public function lineTo(x:Number, y:Number):void
Parameters
x:Number | |
y:Number |
| moveText | () | method |
public function moveText(x:Number, y:Number):voidMoves to the start of the next line, offset from the start of the current line.
Parameters
x:Number — x-coordinate of the new current point
| |
y:Number — y-coordinate of the new current point
|
| moveTo | () | method |
public function moveTo(x:Number, y:Number):voidMove the current point omitting any connecting line segment.
Parameters
x:Number | |
y:Number |
| newlineShowText | () | method |
public function newlineShowText(text:String):voidMoves to the next line and shows text
Parameters
text:String — the text to write
|
| newPath | () | method |
public function newPath():voidEnds the path without filling or stroking it.
| paintShading | () | method |
public function paintShading(value:PdfShading):voidPaint using a shading object
Parameters
value:PdfShading |
| paintShadingPattern | () | method |
public function paintShadingPattern(shading:PdfShadingPattern):voidPaints using a shading pattern.
Parameters
shading:PdfShadingPattern |
| rectangle | () | method |
public function 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 );
Parameters
... params — x-coordinate of the starting point
|
See also
| reset | () | method |
public function reset(value:Boolean = true):void
Makes this PdfContentByte empty.
Calls reset( true )
Parameters
value:Boolean (default = true) |
| resetFill | () | method |
public function resetFill():void
| resetStroke | () | method |
public function resetStroke():void
| restoreState | () | method |
public function restoreState():void
Restores the graphic state. saveState and
restoreState must be balanced.
| roundRectangle | () | method |
public function roundRectangle(x:Number, y:Number, w:Number, h:Number, r:Number):voidAdds a round rectangle to the current path.
Parameters
x:Number | |
y:Number | |
w:Number | |
h:Number | |
r:Number |
| sanityCheck | () | method |
protected function sanityCheck():voidChecks for any error in mismatched save/restore state, begin/end text, begin/end layer, or begin/end marked content sequence.
| saveState | () | method |
public function saveState():void
Saves the graphic state. saveState and
restoreState must be balanced.
| setCharacterSpacing | () | method |
public function setCharacterSpacing(charSpace:Number):voidChange the character spacing
Parameters
charSpace:Number |
| setCMYKFillColor | () | method |
public function setCMYKFillColor(cyan:Number, magenta:Number, yellow:Number, black:Number):voidChanges the current color for filling paths (device dependent colors!).
Parameters
cyan:Number — the intensity of cyan. A value between 0 and 1
| |
magenta:Number — the intensity of magenta. A value between 0 and 1
| |
yellow:Number — the intensity of yellow. A value between 0 and 1
| |
black:Number — the intensity of black. A value between 0 and 1
|
| setCMYKStrokeColor | () | method |
public function setCMYKStrokeColor(cyan:Number, magenta:Number, yellow:Number, black:Number):void
Sets the color space to (or the color space), and sets the color to use for stroking paths.
Each value must be between 0 and 1.
Parameters
cyan:Number | |
magenta:Number | |
yellow:Number | |
black:Number |
| setColorFill | () | method |
public function setColorFill(color:RGBColor):voidSets the fill color
Parameters
color:RGBColor — the color
|
| setColorStroke | () | method |
| setFillColor | () | method |
public function setFillColor(value:uint):voidChanges the current color for filling paths Sets the color space to DeviceRGB
Parameters
value:uint — Color RGB value
|
| setFontAndSize | () | method |
public function setFontAndSize(bf:BaseFont, size:Number):voidSet the font and the size for the subsequent text writing
Parameters
bf:BaseFont | |
size:Number |
| setGrayFill | () | method |
public function setGrayFill(gray:Number):void
Parameters
gray:Number |
| setGrayStroke | () | method |
public function setGrayStroke(gray:Number):void
Parameters
gray:Number |
| setGState | () | method |
public function setGState(gstate:PdfGState):voidApply the graphic state
Parameters
gstate:PdfGState — The graphic state
|
| setLeading | () | method |
public function setLeading(value:Number):void| Since : | 0.22 |
Sets the text leading parameter. The leading parameter is measured in text space units. It specifies the vertical distance between the baselines of adjacent lines of text.
Parameters
value:Number |
| setLineCap | () | method |
public function setLineCap(style:int):void
Changes the
The line cap style specifies the shape to be used at the end of open subpaths when they are stroked.
Parameters
style:int — 0 = CapsStyle.NONE, 1 = CapsStyle.ROUND, 2 = CapsStyle.SQUARE
|
See also
| setLineDash | () | method |
public function setLineDash(phase:Number):voidChanges the value of the line dash pattern.
Parameters
phase:Number |
| setLineDash2 | () | method |
public function setLineDash2(unitsOn:Number, phase:Number):voidChanges the value of the line dash pattern. The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
Parameters
unitsOn:Number — the value of the phase
| |
phase:Number — the number of units that must be 'on' (equals the number of units that must be 'off').
|
| setLineDash3 | () | method |
public function setLineDash3(unitsOn:Number, unitsOff:Number, phase:Number):voidChanges the value of the line dash pattern The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
Parameters
unitsOn:Number — the value of the phase
| |
unitsOff:Number — the number of units that must be 'on'
| |
phase:Number — the number of units that must be 'off'
|
| setLineDash4 | () | method |
public function setLineDash4(array:Vector.<Number>, phase:Number):voidChanges the value of the line dash pattern The line dash pattern controls the pattern of dashes and gaps used to stroke paths. It is specified by an array and a phase. The array specifies the length of the alternating dashes and gaps. The phase specifies the distance into the dash pattern to start the dash
Parameters
array:Vector.<Number> — length of the alternating dashes and gaps
| |
phase:Number — the value of the phase
|
| setLineJoin | () | method |
public function 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).
Parameters
joint:String |
See also
| setLineWidth | () | method |
public function setLineWidth(w:Number):voidChanges the line width.
Parameters
w:Number |
| setLiteral | () | method |
public function setLiteral(value:String):voidOutput a String directly to the content
Parameters
value:String — The content to append
|
| setMiterLimit | () | method |
public function setMiterLimit(miterLimit:Number):voidChanges the Miter limit.
Parameters
miterLimit:Number |
| setPatternFill | () | method |
public function setPatternFill(p:PdfPatternPainter):voidSet the fill color to a pattern
Parameters
p:PdfPatternPainter |
| setPatternFill2 | () | method |
public function setPatternFill2(p:PdfPatternPainter, color:RGBColor):voidSet the fill color of an uncolored pattern
Parameters
p:PdfPatternPainter | |
color:RGBColor |
| setPatternFill3 | () | method |
public function setPatternFill3(p:PdfPatternPainter, color:RGBColor, tint:Number):voidSet the fill color to an uncolored pattern
Parameters
p:PdfPatternPainter | |
color:RGBColor | |
tint:Number |
| setPatternStroke | () | method |
public function setPatternStroke(p:PdfPatternPainter):voidSets the stroke color to a pattern
Parameters
p:PdfPatternPainter |
| setPatternStroke2 | () | method |
public function setPatternStroke2(p:PdfPatternPainter, color:RGBColor):voidSets the stroke color to an uncolored pattern
Parameters
p:PdfPatternPainter | |
color:RGBColor |
| setPatternStroke3 | () | method |
public function setPatternStroke3(p:PdfPatternPainter, color:RGBColor, tint:Number):voidSets the stroke color to an uncolored pattern
Parameters
p:PdfPatternPainter | |
color:RGBColor | |
tint:Number |
| setRectangle | () | method |
pdf_core function setRectangle(rectangle:RectangleElement):void
Parameters
rectangle:RectangleElement |
| setRGBFillColor | () | method |
public function setRGBFillColor(red:int, green:int, blue:int):voidChanges the current color for filling paths Sets the color space to DeviceRGB
Parameters
red:int | |
green:int | |
blue:int |
| setRGBStrokeColor | () | method |
public function setRGBStrokeColor(red:int, green:int, blue:int):void
Parameters
red:int | |
green:int | |
blue:int |
| setShadingFill | () | method |
public function setShadingFill(shading:PdfShadingPattern):voidSets the shading fill pattern.
Parameters
shading:PdfShadingPattern |
| setShadingStroke | () | method |
public function setShadingStroke(shading:PdfShadingPattern):voidSets the shading stroke pattern
Parameters
shading:PdfShadingPattern — the shading pattern
|
| setSpotFillColor | () | method |
public function setSpotFillColor(sp:PdfSpotColor, tint:Number):voidSets the fill color to a spot color.
Parameters
sp:PdfSpotColor — the spot color
| |
tint:Number — the tint for the spot color. ( 0 = no color, 1 = 100% color )
|
| setSpotStrokeColor | () | method |
public function setSpotStrokeColor(sp:PdfSpotColor, tint:Number):voidSets the stroke color to a spot color
Parameters
sp:PdfSpotColor | |
tint:Number |
| setStrokeColor | () | method |
public function setStrokeColor(value:uint):voidParameters
value:uint |
| setTextMatrix | () | method |
public function setTextMatrix(a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, x:Number = 0, y:Number = 0):voidChange the text matrix
Parameters
a:Number (default = 1) | |
b:Number (default = 0) | |
c:Number (default = 0) | |
d:Number (default = 1) | |
x:Number (default = 0) | |
y:Number (default = 0) |
| setTextRenderingMode | () | method |
public function setTextRenderingMode(rendering:int):voidSets the text rendering mode
Parameters
rendering:int |
| setTextRise | () | method |
public function setTextRise(rise:Number):voidThis allows to write text in subscript or superscript mode
Parameters
rise:Number |
| setTransform | () | method |
public function setTransform(m:Matrix):voidConcatenates the transformation to the current matrix
Parameters
m:Matrix |
| setWordSpacing | () | method |
public function setWordSpacing(wordSpace:Number):voidChange the word spacing
Parameters
wordSpace:Number |
| showText | () | method |
public function showText(text:String):voidShows the text
Parameters
text:String |
| showTextAligned | () | method |
public function showTextAligned(alignment:int, text:String, x:Number, y:Number, rotation:Number, kerned:Boolean = false):voidShows text aligned (left, center or right) with rotation.
Parameters
alignment:int — the alignment can be ALIGN_CENTER, ALIGN_RIGHT or ALIGN_LEFT
| |
text:String — the text to show
| |
x:Number — the x position
| |
y:Number — the y position
| |
rotation:Number — the rotation in degrees
| |
kerned:Boolean (default = false) |
| showTextArray | () | method |
public function showTextArray(text:PdfTextArray):voidShow an array of kerned text
Parameters
text:PdfTextArray |
| showTextKerned | () | method |
public function showTextKerned(text:String):voidShows the text kerned
Parameters
text:String |
| stroke | () | method |
public function stroke():voidStrokes the path.
| toPdf | () | method |
| toString | () | method |
public function toString():StringReturns
String —
|
| variableRectangle | () | method |
public function variableRectangle(rect:RectangleElement):voidAdds a variable width border to the current path. Only use if isUseVariableBorders = true
Parameters
rect:RectangleElement — a RectangleElement
|
| ALIGN_CENTER | Constant |
public static const ALIGN_CENTER:int = 1| ALIGN_LEFT | Constant |
public static const ALIGN_LEFT:int = 0| ALIGN_RIGHT | Constant |
public static const ALIGN_RIGHT:int = 2| LINE_CAP_BUTT | Constant |
public static const LINE_CAP_BUTT:int = 0| LINE_CAP_PROJECTING_SQUARE | Constant |
public static const LINE_CAP_PROJECTING_SQUARE:int = 2| LINE_CAP_ROUND | Constant |
public static const LINE_CAP_ROUND:int = 1| LINE_JOIN_BEVEL | Constant |
public static const LINE_JOIN_BEVEL:int = 2| LINE_JOIN_MITER | Constant |
public static const LINE_JOIN_MITER:int = 0| LINE_JOIN_ROUND | Constant |
public static const LINE_JOIN_ROUND:int = 1| TEXT_RENDER_MODE_CLIP | Constant |
public static const TEXT_RENDER_MODE_CLIP:int = 7| TEXT_RENDER_MODE_FILL | Constant |
public static const TEXT_RENDER_MODE_FILL:int = 0| TEXT_RENDER_MODE_FILL_CLIP | Constant |
public static const TEXT_RENDER_MODE_FILL_CLIP:int = 4| TEXT_RENDER_MODE_FILL_STROKE | Constant |
public static const TEXT_RENDER_MODE_FILL_STROKE:int = 2| TEXT_RENDER_MODE_FILL_STROKE_CLIP | Constant |
public static const TEXT_RENDER_MODE_FILL_STROKE_CLIP:int = 6| TEXT_RENDER_MODE_INVISIBLE | Constant |
public static const TEXT_RENDER_MODE_INVISIBLE:int = 3| TEXT_RENDER_MODE_STROKE | Constant |
public static const TEXT_RENDER_MODE_STROKE:int = 1| TEXT_RENDER_MODE_STROKE_CLIP | Constant |
public static const TEXT_RENDER_MODE_STROKE_CLIP:int = 5