FloatingBox

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph com.aspose.pdf.FloatingBox, com.aspose.pdf.BaseParagraph, com.aspose.pdf.FloatingBox

All Implemented Interfaces: com.aspose.ms.System.ICloneable

public class FloatingBox extends BaseParagraph

Represents a FloatingBox in a Pdf document. FloatingBox is custom positioned.

Constructors

Constructor	Description
FloatingBox	Initializes a new instance of the {@code FloatingBox} class.
FloatingBox	Initializes a new instance of the {@code FloatingBox} class with specified width and height.

Methods

Method	Description
deepClone	Clones a new {@code FloatingBox} object. Paragraphs in the floating box are not cloned.
getBackgroundColor	Gets a object that indicates the background color of the floating box.
getBackgroundImage	Gets or sets background image for page (for generator only, not filled in when reading document).
getBorder	Gets a object that indicates the border info of the floating box.
getColumnInfo	Gets a column info
getHeight	Gets a float value that indicates the height of the floating box.
getLeft	Gets the table left coordinate.
getPadding	Gets a object that indicates the padding of the floating box.
getParagraphs	Gets a collection that indicates all paragraphs in the cell.
getPositioningMode	Specifies variant for determining the location of the FloatingBox on the page.
getTop	Gets the table top coordinate.
getWidth	Gets a float value that indicates the width of the floating box.
isNeedRepeating	Gets a boolean value that indicates whether the paragraph need to be repeated on next page. Default value is true.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.
setBackgroundColor	Sets a object that indicates the background color of the floating box.
setBackgroundImage	Gets or sets background image for page (for generator only, not filled in when reading document).
setBorder	Sets a object that indicates the border info of the floating box.
setColumnInfo	Sets a column info
setHeight	Sets a float value that indicates the height of the floating box.
setLeft	Sets the table left coordinate.
setNeedRepeating	Sets a boolean value that indicates whether the paragraph need to be repeated on next page. Default value is true.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.
setPadding	Sets an object that indicates the padding of the floating box.
setParagraphs	Sets a collection that indicates all paragraphs in the cell.
setPositioningMode	Specifies variant for determining the location of the FloatingBox on the page.
setTop	Sets the table top coordinate.
setWidth	Sets a float value that indicates the width of the floating box.

FloatingBox

public FloatingBox()

Initializes a new instance of the {@code FloatingBox} class.

FloatingBox

public FloatingBox(float width, float height)

Initializes a new instance of the {@code FloatingBox} class with specified width and height.

Parameters:

Parameter	Type	Description
width		The width of the box.
height		The height of the box.

deepClone

public Object deepClone()

Clones a new {@code FloatingBox} object. Paragraphs in the floating box are not cloned.

Returns: The new {@code FloatingBox} object.

getBackgroundColor

public Color getBackgroundColor()

Gets a object that indicates the background color of the floating box.

Returns: object that indicates the background color.

getBackgroundImage

public final Image getBackgroundImage()

Gets or sets background image for page (for generator only, not filled in when reading document).

Returns: Image instance

getBorder

public BorderInfo getBorder()

Gets a object that indicates the border info of the floating box.

Returns: object that indicates the border info.

getColumnInfo

public ColumnInfo getColumnInfo()

Gets a column info

Returns: ColumnInfo object

getHeight

public double getHeight()

Gets a float value that indicates the height of the floating box.

Returns: value that indicates the height.

getLeft

public double getLeft()

Gets the table left coordinate.

Returns: table left coordinate.

getPadding

public MarginInfo getPadding()

Gets a object that indicates the padding of the floating box.

Returns: object that indicates the padding.

getParagraphs

public Paragraphs getParagraphs()

Gets a collection that indicates all paragraphs in the cell.

Returns: collection that indicates all paragraphs.

getPositioningMode

public final ParagraphPositioningMode getPositioningMode()

Specifies variant for determining the location of the FloatingBox on the page.

Returns: ParagraphPositioningMode element

getTop

public double getTop()

Gets the table top coordinate.

Returns: table top coordinate.

getWidth

public double getWidth()

Gets a float value that indicates the width of the floating box.

Returns: double value

isNeedRepeating

public boolean isNeedRepeating()

Gets a boolean value that indicates whether the paragraph need to be repeated on next page. Default value is true.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.

Returns: boolean value

setBackgroundColor

Sets a object that indicates the background color of the floating box.

setBackgroundImage

Gets or sets background image for page (for generator only, not filled in when reading document).

setBorder

Sets a object that indicates the border info of the floating box.

setColumnInfo

Sets a column info

setHeight

public void setHeight(double value)

Sets a float value that indicates the height of the floating box.

Parameters:

Parameter	Type	Description
value		value that indicates the height.

setLeft

public void setLeft(double value)

Sets the table left coordinate.

Parameters:

Parameter	Type	Description
value		table left coordinate.

setNeedRepeating

public void setNeedRepeating(boolean value)

Sets a boolean value that indicates whether the paragraph need to be repeated on next page. Default value is true.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.

Parameters:

Parameter	Type	Description
value		boolean value

setPadding

Sets an object that indicates the padding of the floating box.

setParagraphs

Sets a collection that indicates all paragraphs in the cell.

setPositioningMode

Specifies variant for determining the location of the FloatingBox on the page.

setTop

public void setTop(double value)

Sets the table top coordinate.

Parameters:

Parameter	Type	Description
value		table top coordinate.

setWidth

public void setWidth(double value)

Sets a float value that indicates the width of the floating box.

Parameters:

Parameter	Type	Description
value		double value