FloatingBox

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

public class FloatingBox extends BaseParagraph

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

Constructors

ConstructorDescription
FloatingBox(float width, float height)Initializes a new instance of the FloatingBox class with specified width and height.
FloatingBox()Initializes a new instance of the FloatingBox class.

Methods

MethodDescription
getColumnInfo()Gets a column info
setColumnInfo(ColumnInfo value)Sets a column info
getWidth()Gets a float value that indicates the width of the floating box.
setWidth(double value)Sets a float value that indicates the width of the floating box.
getHeight()Gets a float value that indicates the height of the floating box.
setHeight(double value)Sets a float value that indicates the height of the floating box.
isNeedRepeating()Gets a boolean value that indicates whether the paragraph need to be repeated on next page.
setNeedRepeating(boolean value)Sets a boolean value that indicates whether the paragraph need to be repeated on next page.
getParagraphs()Gets a collection that indicates all paragraphs in the cell.
setParagraphs(Paragraphs value)Sets a collection that indicates all paragraphs in the cell.
getBorder()Gets a object that indicates the border info of the floating box.
setBorder(BorderInfo value)Sets a object that indicates the border info of the floating box.
getBackgroundColor()Gets a object that indicates the background color of the floating box.
setBackgroundColor(Color value)Sets 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).
setBackgroundImage(Image value)Gets or sets background image for page (for generator only, not filled in when reading document).
getPadding()Gets a object that indicates the padding of the floating box.
setPadding(MarginInfo value)Sets a object that indicates the padding of the floating box.
getLeft()Gets the table left coordinate.
setLeft(double value)Sets the table left coordinate.
getTop()Gets the table top coordinate.
setTop(double value)Sets the table top coordinate.
deepClone()Clones a new FloatingBox object.

FloatingBox(float width, float height)

public FloatingBox(float width, float height)

Initializes a new instance of the FloatingBox class with specified width and height.

Parameters:

ParameterTypeDescription
widthfloatThe width of the box.
heightfloatThe height of the box.

FloatingBox()

public FloatingBox()

Initializes a new instance of the FloatingBox class.

getColumnInfo()

public ColumnInfo getColumnInfo()

Gets a column info

Returns: ColumnInfo - ColumnInfo object

setColumnInfo(ColumnInfo value)

public void setColumnInfo(ColumnInfo value)

Sets a column info

Parameters:

ParameterTypeDescription
valueColumnInfoColumnInfo value

getWidth()

public double getWidth()

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

Returns: double - double value

setWidth(double value)

public void setWidth(double value)

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

Parameters:

ParameterTypeDescription
valuedoubledouble value

getHeight()

public double getHeight()

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

Returns: double - value that indicates the height.

setHeight(double value)

public void setHeight(double value)

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

Parameters:

ParameterTypeDescription
valuedoublevalue that indicates the height.

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 - boolean value

setNeedRepeating(boolean value)

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:

ParameterTypeDescription
valuebooleanboolean value

getParagraphs()

public Paragraphs getParagraphs()

Gets a collection that indicates all paragraphs in the cell.

Returns: Paragraphs - collection that indicates all paragraphs.

setParagraphs(Paragraphs value)

public void setParagraphs(Paragraphs value)

Sets a collection that indicates all paragraphs in the cell.

Parameters:

ParameterTypeDescription
valueParagraphscollection that indicates all paragraphs.

getBorder()

public BorderInfo getBorder()

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

Returns: BorderInfo - object that indicates the border info.

setBorder(BorderInfo value)

public void setBorder(BorderInfo value)

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

Parameters:

ParameterTypeDescription
valueBorderInfoobject that indicates the border info.

getBackgroundColor()

public Color getBackgroundColor()

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

Returns: Color - object that indicates the background color.

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

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

Parameters:

ParameterTypeDescription
valueColorobject 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 - Image instance

setBackgroundImage(Image value)

public final void setBackgroundImage(Image value)

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

Parameters:

ParameterTypeDescription
valueImageImage instance

getPadding()

public MarginInfo getPadding()

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

Returns: MarginInfo - object that indicates the padding.

setPadding(MarginInfo value)

public void setPadding(MarginInfo value)

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

Parameters:

ParameterTypeDescription
valueMarginInfoobject that indicates the padding.

getLeft()

public double getLeft()

Gets the table left coordinate.

Returns: double - table left coordinate.

setLeft(double value)

public void setLeft(double value)

Sets the table left coordinate.

Parameters:

ParameterTypeDescription
valuedoubletable left coordinate.

getTop()

public double getTop()

Gets the table top coordinate.

Returns: double - table top coordinate.

setTop(double value)

public void setTop(double value)

Sets the table top coordinate.

Parameters:

ParameterTypeDescription
valuedoubletable top coordinate.

deepClone()

public Object deepClone()

Clones a new FloatingBox object. Paragraphs in the floating box are not cloned.

Returns: java.lang.Object - The new FloatingBox object.