public class

Float

extends ContentContainer
java.lang.Object
   ↳ com.pdftron.layout.ContentElement
     ↳ com.pdftron.layout.ContentNode
       ↳ com.pdftron.layout.ContentContainer
         ↳ com.pdftron.layout.Float

Class Overview

A Float takes its content out of the main content flow and positions it relative to a reference point, with the document content wrapped around it.

Summary

Nested Classes
enum Float.ObstructionType The way the document content flows around a float. 
enum Float.ReferencePoint The reference point a float is positioned relative to. 
Public Methods
Float.ReferencePoint getHorizontalReferencePoint()
Float.ObstructionType getObstructionType()
double getPositionX()
double getPositionY()
Float.ReferencePoint getVerticalReferencePoint()
void setHorizontalReferencePoint(Float.ReferencePoint point)
Sets the reference point the horizontal position is relative to.
void setObstructionType(Float.ObstructionType type)
Sets the way the document content flows around the float.
void setPositionX(double xPoints)
Sets the horizontal position of the float, relative to its horizontal reference point.
void setPositionY(double yPoints)
Sets the vertical position of the float, relative to its vertical reference point.
void setVerticalReferencePoint(Float.ReferencePoint point)
Sets the reference point the vertical position is relative to.
[Expand]
Inherited Methods
From class com.pdftron.layout.ContentContainer
From class com.pdftron.layout.ContentNode
From class com.pdftron.layout.ContentElement
From class java.lang.Object

Public Methods

public Float.ReferencePoint getHorizontalReferencePoint ()

Returns
  • The reference point the horizontal position is relative to
Throws
PDFNetException

public Float.ObstructionType getObstructionType ()

Returns
  • The way the document content flows around the float
Throws
PDFNetException

public double getPositionX ()

Returns
  • The horizontal position of the float in points
Throws
PDFNetException

public double getPositionY ()

Returns
  • The vertical position of the float in points
Throws
PDFNetException

public Float.ReferencePoint getVerticalReferencePoint ()

Returns
  • The reference point the vertical position is relative to
Throws
PDFNetException

public void setHorizontalReferencePoint (Float.ReferencePoint point)

Sets the reference point the horizontal position is relative to.

Parameters
point The horizontal reference point
Throws
PDFNetException

public void setObstructionType (Float.ObstructionType type)

Sets the way the document content flows around the float.

Parameters
type The obstruction type
Throws
PDFNetException

public void setPositionX (double xPoints)

Sets the horizontal position of the float, relative to its horizontal reference point.

Parameters
xPoints The horizontal position in points
Throws
PDFNetException

public void setPositionY (double yPoints)

Sets the vertical position of the float, relative to its vertical reference point.

Parameters
yPoints The vertical position in points
Throws
PDFNetException

public void setVerticalReferencePoint (Float.ReferencePoint point)

Sets the reference point the vertical position is relative to.

Parameters
point The vertical reference point
Throws
PDFNetException