public class LayoutBox.Box extends Object
A class representing a Box, several of which make up the visible content of a LayoutBox. Boxs on their own represent nothing but a space in the LayoutBox layout - if the rectangle is to be filled with some content (an image, for example), that has to be done separately.
The LayoutBox.Text
class is a subclass of Box which is used to
specifically display a phrase of text.
LayoutBox.getBoxes()
Modifier and Type | Method and Description |
---|---|
float |
getBottom()
Return the bottom edge of this Box relative to the parent LayoutBox, in points.
|
float[] |
getCorners(float x,
float y)
Return an array of n * 8 points, the coordinates of the corners of this
Box and any subsequent Boxes created by the same item.
|
PDFImage |
getImage()
Return the optional image set by the
setImage method,
or null if no image was defined. |
float |
getLeft()
Return the left edge of this Box relative to the parent LayoutBox, in points
|
float |
getLineBottom()
Return the bottom edge of the line this Box sits on, relative to the parent
LayoutBox, in points.
|
int |
getLineNumber()
Return which line number this text belongs to.
|
float |
getLineTop()
Return the top edge of the line this Box sits on, relative to the parent
LayoutBox, in points.
|
Object |
getLinkedObject()
Return the object set via
setLinkedObject(java.lang.Object) |
LayoutBox |
getParent()
Return the LayoutBox that this Box is a child of
|
float |
getRight()
Return the right edge of this Box relative to the parent LayoutBox, in points
|
float |
getTop()
Return the top edge of this Box relative to the parent LayoutBox, in points.
|
void |
setImage(PDFImage image)
Set an optional image which goes with this Box.
|
void |
setLinkedObject(Object o)
Associate an object with this Box.
|
String |
toString() |
public final int getLineNumber()
LayoutBox.addLineBreak(org.faceless.pdf2.PDFStyle)
do not count as lines.
Left or right floating boxes will have the same line number as the text next
to the top of the box. If the LayoutBox has not been flushed then this method
may return -1, indicating the line number hasn't been set yet.public final float getLeft()
public final float getRight()
public final float getTop()
getBottom()
,
getLineTop()
public final float getBottom()
getTop()
,
getLineBottom()
public final float getLineTop()
getLineBottom()
,
getTop()
public final float getLineBottom()
getLineTop()
,
getTop()
public final float[] getCorners(float x, float y)
AnnotationLink.setCorners()
or
AnnotationMarkup.setCorners()
, for
example
LayoutBox box = ...; LayoutBox.Text[] text = box.addText("Some text here", style, null); box.flush(); box.drawLayoutBox(box, x, y); AnnotationLink link = new AnnotationLink(); link.setCorners(text[0].getCorners(x, y));
x
- the X co-ordinate the LayoutBox was drawn aty
- the Y co-ordinate the LayoutBox was drawn atpublic void setImage(PDFImage image)
public PDFImage getImage()
setImage
method,
or null
if no image was defined.public LayoutBox getParent()
public final Object getLinkedObject()
setLinkedObject(java.lang.Object)
public final void setLinkedObject(Object o)
LayoutBox.splitAt(float)
call. Used in the Report
Generator, but probably not much use for most end users.Copyright © 2001-2017 Big Faceless Organization