Java Doc for BoundingBox.java in  » PDF » gnujpdf » gnu » jpdf » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This class simplifies the placement of Strings within a canvas area where the placement of objects is absolute

A BoundingBox is just a Rectangle that knows how to find the coordinates for a String based on the desired alignment and FontMetrics. For each new String, a new child BoundingBox is made that can be subtracted from the original box so new Strings can be added

One of the more helpful features of this class is the string wrap feature of getStringBounds. The box returned by that method will contain an array of strings that have been broken down to fit the box. The box's coordinates and size will reflect the size of the entire group of strings if it is laid out as expected. Using the returned box and iterating through the array of strings from top to bottom, getting new bounding boxes for each one (with upper left alignment and no padding) will result in the correct string wrap.

Note that you will need to have Xvfb running on a Unix server to use this class

Make the specified box this box's child.

Take the first line of the string (if it is wrapped, otherwise just take the whole string) and chop the end of it off to make it fit in the box.

This method is called after getting the box by calling getStringBounds on the parent.

Draws lines from the wrapped string until there is no more room and then stops.

Gets the drawing point to use in Graphics drawing methods.

Gets the location of a String after it is adjusted for alignment within this box.

Gets the location of a String after it is adjusted for alignment within this box.

Returns true if this box has a parent.

Removes the child box from this parent box.

Make the specified box this box's child. Equivalent to child.setParent(parent) where the specified 'parent' is this instance

Returns false if for any reason this box has negative dimensions

Take the first line of the string (if it is wrapped, otherwise just take the whole string) and chop the end of it off to make it fit in the box. If the box is smaller than one letter, draw nothing

This method is called after getting the box by calling getStringBounds on the parent. Wraps the string at word boundaries and draws it to the specified Graphics context. Make sure padding is the same as specified for the getStringBounds call, or you may get an unexpected gnu.jpdf.StringTooLongException

Draws lines from the wrapped string until there is no more room and then stops. If there is no string or the box is too small for anything to be drawn, does nothing

Get the absolute upper left location point for this box

Gets the drawing point to use in Graphics drawing methods. After getting a new BoundingBox with getStringBounds(), calling this method will give you an absolute point, accounting for alignment and padding, etc, from which to start drawing the String

If getStringBounds was not called (this is a parent box), the upper left coordinates will be returned (this.getLocation())

Returns the full string associated with a call to getStringBounds

Get this box's parent box

Get the wrapped strings if this box was from a call to getStringBounds, otherwise this method returns null

Gets the location of a String after it is adjusted for alignment within this box. The point's coordinates are either within this box or within the enclosing area.

Gets the location of a String after it is adjusted for alignment within this box. The point's coordinates are either within this box or within the enclosing area.

By default, this method enforces string length and throws the exception if it is too long

Returns true if this box has a parent. The 'world', or enclosing canvas is not considered a parent

Set the absolute upper left world location point for this box

Sets the full string associated with getStringBounds

Make the specified box this box's parent

Set the value of the string array

Removes the child box from this parent box. The child must have this object as its parent or the method does nothing. The BoundingBox returned will be cut by an area equal to the child area plus the horizontal or vertical strip in which it sits, depending on the 'subtractFrom' value passed in