|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
aspose.pdf.FloatingBox
public class FloatingBox
Represents a FloatingBox Paragraph
in a Pdf document.
FloatingBox is custom positioned.
Typical usages are the following:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class aspose.pdf.Paragraph |
---|
Paragraph.VerticalPositionInfo |
Field Summary | |
---|---|
boolean |
IsInCanvas
|
Fields inherited from class aspose.pdf.Paragraph |
---|
isNeedAddToPage, isPositionProcessed, RealPageNumber, VerticalPosInfo |
Constructor Summary | |
---|---|
FloatingBox()
Constructor - initializes a new instance of the FloatingBox class. |
|
FloatingBox(float width,
float height)
Constructor - initializes a new instance of the FloatingBox class with
specified width and height. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones a new FloatingBox object. |
java.lang.Object |
completeClone()
Clones a new FloatingBox object. |
Color |
getBackgroundColor()
Gets a Color object that indicates the background color of the floating
box. |
BorderInfo |
getBorder()
Gets a BorderInfo object that indicates the border info of the floating
box. |
float |
getBoxHeight()
Gets a float value that indicates the height of the floating box. |
BoxHorizontalAlignmentType |
getBoxHorizontalAlignment()
Gets a BoxHorizontalAlignmentType object that indicates the horizontal
alignment type of the floating box. |
BoxHorizontalPositioningType |
getBoxHorizontalPositioning()
Gets a BoxHorizontalPositioningType object that indicates the horizontal
positioning type of the floating box. |
BoxVerticalAlignmentType |
getBoxVerticalAlignment()
Gets a BoxVerticalAlignmentType object that indicates the vertical
alignment type of the floating box. |
BoxVerticalPositioningType |
getBoxVerticalPositioning()
Gets a BoxVerticalPositioningType object that indicates the vertical
positioning type of the floating box. |
float |
getBoxWidth()
Gets a float value that indicates the width of the floating box. |
boolean |
getIsNeedRepeating()
Gets a boolean value that indicates whether the paragraph need to be repeated on next page. |
boolean |
getIsWidthSet()
Gets a boolean value that indicates whether width has been set. |
MarginInfo |
getPadding()
Gets a MarginInfo object that indicates the padding of the floating box. |
Paragraphs |
getParagraphs()
Gets a Paragraphs collection that indicates all paragraphs in the cell. |
VerticalAlignmentType |
getTextVerticalAlignment()
Gets a VerticalAlignmentType enum that indicates the vertical alignment
type of all paragraphs in the floating box. |
VerticalTextRotationType |
getVerticalTextRotationAngle()
Gets a VerticalTextRotationType object that indicates the text rotation
angle in floating box or cells. |
int |
getZIndex()
Gets an int value that indicates the Z-order of the floating box. |
void |
setBackgroundColor(Color value)
Sets a Color object that indicates the background color of the floating
box. |
void |
setBorder(BorderInfo value)
Sets a BorderInfo object that indicates the border info of the floating
box. |
void |
setBoxHeight(float value)
Sets a float value that indicates the height of the floating box. |
void |
setBoxHorizontalAlignment(BoxHorizontalAlignmentType value)
Sets a BoxHorizontalAlignmentType object that indicates the horizontal
alignment type of the floating box. |
void |
setBoxHorizontalPositioning(BoxHorizontalPositioningType value)
Sets a BoxHorizontalPositioningType object that indicates the horizontal
positioning type of the floating box. |
void |
setBoxVerticalAlignment(BoxVerticalAlignmentType value)
Sets a BoxVerticalAlignmentType object that indicates the vertical
alignment type of the floating box. |
void |
setBoxVerticalPositioning(BoxVerticalPositioningType value)
Sets a BoxVerticalPositioningType object that indicates the vertical
positioning type of the floating box. |
void |
setBoxWidth(float value)
Sets a float value that indicates the width of the floating box. |
void |
setIsNeedRepeating(boolean value)
Sets a boolean value that indicates whether the paragraph need to be repeated on next page. |
void |
setIsWidthSet(boolean value)
Sets a boolean value that indicates whether width has been set. |
void |
setPadding(MarginInfo value)
Sets a MarginInfo object that indicates the padding of the floating box. |
void |
setParagraphs(Paragraphs value)
Sets a Paragraphs collection that indicates all paragraphs in the cell. |
void |
setTextVerticalAlignment(VerticalAlignmentType value)
Sets a VerticalAlignmentType enum that indicates the vertical alignment
type of all paragraphs in the floating box. |
void |
setVerticalTextRotationAngle(VerticalTextRotationType value)
Sets a VerticalTextRotationType object that indicates the text rotation
angle in floating box or cells. |
void |
setZIndex(int value)
Sets an int value that indicates the Z-order of the floating box. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public boolean IsInCanvas
Constructor Detail |
---|
public FloatingBox()
FloatingBox
class.
public FloatingBox(float width, float height)
FloatingBox
class with
specified width and height.
width
- The width of the box.height
- The height of the box.Method Detail |
---|
public boolean getIsWidthSet()
public void setIsWidthSet(boolean value)
value
- A boolean value.public float getBoxWidth()
public void setBoxWidth(float value)
value
- A float value.public float getBoxHeight()
public void setBoxHeight(float value)
value
- A float value.public boolean getIsNeedRepeating()
public void setIsNeedRepeating(boolean value)
value
- A boolean value.public Paragraphs getParagraphs()
Paragraphs
collection that indicates all paragraphs in the cell.
Paragraphs
object.public void setParagraphs(Paragraphs value)
Paragraphs
collection that indicates all paragraphs in the cell.
value
- A Paragraphs
object.public BoxHorizontalPositioningType getBoxHorizontalPositioning()
BoxHorizontalPositioningType
object that indicates the horizontal
positioning type of the floating box.
BoxHorizontalPositioningType
object.public void setBoxHorizontalPositioning(BoxHorizontalPositioningType value)
BoxHorizontalPositioningType
object that indicates the horizontal
positioning type of the floating box.
value
- A BoxHorizontalPositioningType
object.public BoxVerticalPositioningType getBoxVerticalPositioning()
BoxVerticalPositioningType
object that indicates the vertical
positioning type of the floating box.
BoxVerticalPositioningType
object.public void setBoxVerticalPositioning(BoxVerticalPositioningType value)
BoxVerticalPositioningType
object that indicates the vertical
positioning type of the floating box.
value
- A BoxVerticalPositioningType
object.public BoxHorizontalAlignmentType getBoxHorizontalAlignment()
BoxHorizontalAlignmentType
object that indicates the horizontal
alignment type of the floating box.
BoxHorizontalAlignmentType
object.public void setBoxHorizontalAlignment(BoxHorizontalAlignmentType value)
BoxHorizontalAlignmentType
object that indicates the horizontal
alignment type of the floating box.
value
- A BoxHorizontalAlignmentType
object.public BoxVerticalAlignmentType getBoxVerticalAlignment()
BoxVerticalAlignmentType
object that indicates the vertical
alignment type of the floating box.
BoxVerticalAlignmentType
object.public void setBoxVerticalAlignment(BoxVerticalAlignmentType value)
BoxVerticalAlignmentType
object that indicates the vertical
alignment type of the floating box.
value
- A BoxVerticalAlignmentType
object.public VerticalAlignmentType getTextVerticalAlignment()
VerticalAlignmentType
enum that indicates the vertical alignment
type of all paragraphs in the floating box.
VerticalAlignmentType
object.public void setTextVerticalAlignment(VerticalAlignmentType value)
VerticalAlignmentType
enum that indicates the vertical alignment
type of all paragraphs in the floating box.
value
- A VerticalAlignmentType
object.public BorderInfo getBorder()
BorderInfo
object that indicates the border info of the floating
box.
BorderInfo
object.public void setBorder(BorderInfo value)
BorderInfo
object that indicates the border info of the floating
box.
value
- A BorderInfo
object.public Color getBackgroundColor()
Color
object that indicates the background color of the floating
box.
Color
object.public void setBackgroundColor(Color value)
Color
object that indicates the background color of the floating
box.
value
- A Color
object.public MarginInfo getPadding()
MarginInfo
object that indicates the padding of the floating box.
MarginInfo
object.public void setPadding(MarginInfo value)
MarginInfo
object that indicates the padding of the floating box.
value
- A MarginInfo
object.public VerticalTextRotationType getVerticalTextRotationAngle()
VerticalTextRotationType
object that indicates the text rotation
angle in floating box or cells.
VerticalTextRotationType
object.public void setVerticalTextRotationAngle(VerticalTextRotationType value)
VerticalTextRotationType
object that indicates the text rotation
angle in floating box or cells.
value
- A VerticalTextRotationType
object.public int getZIndex()
public void setZIndex(int value)
value
- An int value.public java.lang.Object clone()
FloatingBox
object. Paragraphs in the floating box are not
cloned.
clone
in class java.lang.Object
FloatingBox
object.public java.lang.Object completeClone()
FloatingBox
object. All members in the FloatingBox are
cloned.
FloatingBox
object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |