com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Skip navigation links
com.aspose.pdf

Class 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.

    • Constructor Detail

      • FloatingBox

        public FloatingBox(float width,
                   float height)

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

        Parameters:
        width - The width of the box.
        height - The height of the box.

      • FloatingBox

        public FloatingBox()

        Initializes a new instance of the FloatingBox class.

    • Method Detail

      • getColumnInfo

        public ColumnInfo getColumnInfo()
        Gets a column info
        Returns:
        ColumnInfo object

      • setColumnInfo

        public void setColumnInfo(ColumnInfo value)
        Sets a column info
        Parameters:
        value - ColumnInfo value

      • getWidth

        public double getWidth()
        Gets a float value that indicates the width of the floating box.
        Returns:
        double value

      • setWidth

        public void setWidth(double value)
        Sets a float value that indicates the width of the floating box.
        Parameters:
        value - double value

      • getHeight

        public double getHeight()
        Gets a float value that indicates the height of the floating box.
        Returns:
        value that indicates the height.

      • setHeight

        public void setHeight(double value)
        Sets a float value that indicates the height of the floating box.
        Parameters:
        value - value 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 false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.
        Returns:
        boolean value

      • 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 false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.
        Parameters:
        value - boolean value

      • getParagraphs

        public Paragraphs getParagraphs()
        Gets a collection that indicates all paragraphs in the cell.
        Returns:
        collection that indicates all paragraphs.

      • setParagraphs

        public void setParagraphs(Paragraphs value)

        Sets a collection that indicates all paragraphs in the cell.

        Parameters:
        value - collection that indicates all paragraphs.

      • getBorder

        public BorderInfo getBorder()
        Gets a object that indicates the border info of the floating box.
        Returns:
        object that indicates the border info.

      • setBorder

        public void setBorder(BorderInfo value)
        Sets a object that indicates the border info of the floating box.
        Parameters:
        value - object that indicates the border info.

      • getBackgroundColor

        public Color getBackgroundColor()
        Gets a object that indicates the background color of the floating box.
        Returns:
        object that indicates the background color.

      • setBackgroundColor

        public void setBackgroundColor(Color value)
        Sets a object that indicates the background color of the floating box.
        Parameters:
        value - object that indicates the background color.

      • getBackgroundImage

        public final Image getBackgroundImage()

        Gets or sets background image for page (for generator only).

        Returns:
        Image instance

      • setBackgroundImage

        public final void setBackgroundImage(Image value)

        Gets or sets background image for page (for generator only).

        Parameters:
        value - Image instance

      • getPadding

        public MarginInfo getPadding()

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

        Returns:
        object that indicates the padding.

      • setPadding

        public void setPadding(MarginInfo value)

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

        Parameters:
        value - object that indicates the padding.

      • getLeft

        public double getLeft()

        Gets the table left coordinate.

        Returns:
        table left coordinate.

      • setLeft

        public void setLeft(double value)

        Sets the table left coordinate.

        Parameters:
        value - table left coordinate.

      • getTop

        public double getTop()

        Gets the table top coordinate.

        Returns:
        table top coordinate.

      • setTop

        public void setTop(double value)

        Sets the table top coordinate.

        Parameters:
        value - table top coordinate.

      • deepClone

        public Object deepClone()

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

        Specified by:
        deepClone in interface com.aspose.ms.System.ICloneable
        Overrides:
        deepClone in class BaseParagraph
        Returns:
        The new FloatingBox object.