Package com.lowagie.text.pdf.draw
Class VerticalPositionMark
java.lang.Object
com.lowagie.text.pdf.draw.VerticalPositionMark
- All Implemented Interfaces:
Element
,DrawInterface
- Direct Known Subclasses:
LineSeparator
Helper class implementing the DrawInterface. Can be used to add horizontal or vertical separators. Won't draw
anything unless you implement the draw method.
- Since:
- 2.1.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DrawInterface
Another implementation of the DrawInterface; its draw method will overrule LineSeparator.draw().protected float
The offset for the line.Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a vertical position mark that won't draw anything unless you define a DrawInterface.VerticalPositionMark
(DrawInterface drawInterface, float offset) Creates a vertical position mark that won't draw anything unless you define a DrawInterface. -
Method Summary
Modifier and TypeMethodDescriptionvoid
draw
(PdfContentByte canvas, float llx, float lly, float urx, float ury, float y) Implement this method if you want to draw something at the current Y position (for instance a line).Gets all the chunks in this element.Getter for the interface with the overruling draw() method.float
Getter for the offset relative to the baseline of the current line.boolean
Checks if this element is a content object.boolean
Checks if this element is nestable.boolean
process
(ElementListener listener) Processes the element by adding it (or the different parts) to anElementListener
.void
setDrawInterface
(DrawInterface drawInterface) Setter for the interface with the overruling draw() method.void
setOffset
(float offset) Setter for the offset.int
type()
Gets the type of the text element.
-
Field Details
-
drawInterface
Another implementation of the DrawInterface; its draw method will overrule LineSeparator.draw(). -
offset
protected float offsetThe offset for the line.
-
-
Constructor Details
-
VerticalPositionMark
public VerticalPositionMark()Creates a vertical position mark that won't draw anything unless you define a DrawInterface. -
VerticalPositionMark
Creates a vertical position mark that won't draw anything unless you define a DrawInterface.- Parameters:
drawInterface
- the drawInterface for this vertical position mark.offset
- the offset for this vertical position mark.
-
-
Method Details
-
draw
Description copied from interface:DrawInterface
Implement this method if you want to draw something at the current Y position (for instance a line).- Specified by:
draw
in interfaceDrawInterface
- Parameters:
canvas
- the canvas on which you can drawllx
- the x coordinate of the left page marginlly
- the y coordinate of the bottom page marginurx
- the x coordinate of the right page marginury
- the y coordinate of the top page marginy
- the current y position on the page- See Also:
-
process
Description copied from interface:Element
Processes the element by adding it (or the different parts) to anElementListener
. -
type
public int type()Description copied from interface:Element
Gets the type of the text element. -
isContent
public boolean isContent()Description copied from interface:Element
Checks if this element is a content object. If not, it's a metadata object. -
isNestable
public boolean isNestable()Description copied from interface:Element
Checks if this element is nestable.- Specified by:
isNestable
in interfaceElement
- Returns:
- true if this element can be nested inside other elements.
- See Also:
-
getChunks
Description copied from interface:Element
Gets all the chunks in this element. -
getDrawInterface
Getter for the interface with the overruling draw() method.- Returns:
- a DrawInterface implementation
-
setDrawInterface
Setter for the interface with the overruling draw() method.- Parameters:
drawInterface
- a DrawInterface implementation
-
getOffset
public float getOffset()Getter for the offset relative to the baseline of the current line.- Returns:
- an offset
-
setOffset
public void setOffset(float offset) Setter for the offset. The offset is relative to the current Y position. If you want to underline something, you have to choose a negative offset.- Parameters:
offset
- an offset
-