Groupdocs API References – com.groupdocs.annotation.models

Java: PageInfo

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class PageInfo

Represents Document Page Information.

Constructors

Constructor	Description
PageInfo()
PageInfo(int width, int height)	Initializes new instance of PageInfo class.
PageInfo(PageInfo pageInfo)	Initializes new instance of PageInfo class.

Methods

Method	Description
getWidth()	Page width
setWidth(int value)	Page width
getHeight()	Page height
setHeight(int value)	Page height
getPageNumber()	Page number
setPageNumber(int value)	Page number
getTextLines()	Text lines information
setTextLines(List value)	Text lines information
equals(Object obj)
equals(PageInfo obj1, PageInfo obj2)
hashCode()

PageInfo()

public PageInfo()

PageInfo(int width, int height)

public PageInfo(int width, int height)

Initializes new instance of PageInfo class.

Parameters:

Parameter	Type	Description
width	int	Page Width.
height	int	Page Height.

PageInfo(PageInfo pageInfo)

public PageInfo(PageInfo pageInfo)

Initializes new instance of PageInfo class.

Parameters:

Parameter	Type	Description
pageInfo	PageInfo	Page Info source.

getWidth()

public final int getWidth()

Page width

Returns: int -

setWidth(int value)

public final void setWidth(int value)

Page width

Parameters:

Parameter	Type	Description
value	int

getHeight()

public final int getHeight()

Page height

Returns: int -

setHeight(int value)

public final void setHeight(int value)

Page height

Parameters:

Parameter	Type	Description
value	int

getPageNumber()

public final int getPageNumber()

Page number

Returns: int -

setPageNumber(int value)

public final void setPageNumber(int value)

Page number

Parameters:

Parameter	Type	Description
value	int

getTextLines()

public final List<TextLineInfo> getTextLines()

Text lines information

Returns: java.util.List<com.groupdocs.annotation.models.TextLineInfo> -

setTextLines(List value)

public final void setTextLines(List<TextLineInfo> value)

Text lines information

Parameters:

Parameter	Type	Description
value	java.util.List<com.groupdocs.annotation.models.TextLineInfo>

equals(Object obj)

public boolean equals(Object obj)

Parameters:

Parameter	Type	Description
obj	java.lang.Object

Returns: boolean

equals(PageInfo obj1, PageInfo obj2)

public static boolean equals(PageInfo obj1, PageInfo obj2)

Parameters:

Parameter	Type	Description
obj1	PageInfo
obj2	PageInfo

Returns: boolean

hashCode()

public int hashCode()

Returns: int

Java: PenStyle

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum

public final class PenStyle extends System.Enum

Pen style

Fields

Field	Description
SOLID	Specifies a solid line
DASH	Specifies a line consisting of dashes
DASH_DOT	Specifies a line consisting of dashes and dots
DOT	Specifies a line consisting of dots
LONG_DASH	Specifies a line consisting of long dashes
DASH_DOT_DOT	Specifies a line consisting of dashes and two dots

Methods

Method	Description
numbers()
getName(Byte type)

SOLID

public static final Byte SOLID

Specifies a solid line

DASH

public static final Byte DASH

Specifies a line consisting of dashes

DASH_DOT

public static final Byte DASH_DOT

Specifies a line consisting of dashes and dots

DOT

public static final Byte DOT

Specifies a line consisting of dots

LONG_DASH

public static final Byte LONG_DASH

Specifies a line consisting of long dashes

DASH_DOT_DOT

public static final Byte DASH_DOT_DOT

Specifies a line consisting of dashes and two dots

numbers()

public static Byte[] numbers()

Returns: java.lang.Byte[]

getName(Byte type)

public static String getName(Byte type)

Parameters:

Parameter	Type	Description
type	java.lang.Byte

Returns: java.lang.String

Java: Point

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class Point

Represents point.

Constructors

Constructor	Description
Point()
Point(float x, float y)	Initializes a new instance of the Point struct.
Point(Point point)	Initializes a new instance of Point class.

Methods

Method	Description
isPointCollectionsEqual(List points1, List points2)
opEquality(Point left, Point right)	Compares two Point objects.
opInequality(Point left, Point right)	Compares two Point objects.
equals(Point obj1, Point obj2)
getX()	Gets or sets the x.
setX(float value)	Gets or sets the x.
getY()	Gets or sets the y.
setY(float value)	Gets or sets the y.
equals(Object obj)	Determines whether the specified point is equal to the current point.
hashCode()	Serves as the default hash function.
toString()

Point()

public Point()

Point(float x, float y)

public Point(float x, float y)

Initializes a new instance of the Point struct.

Parameters:

Parameter	Type	Description
x	float	The x.
y	float	The y.

Point(Point point)

public Point(Point point)

Initializes a new instance of Point class.

Parameters:

Parameter	Type	Description
point	Point	The point source.

isPointCollectionsEqual(List points1, List points2)

public static boolean isPointCollectionsEqual(List<Point> points1, List<Point> points2)

Parameters:

Parameter	Type	Description
points1	java.util.List<com.groupdocs.annotation.models.Point>
points2	java.util.List<com.groupdocs.annotation.models.Point>

Returns: boolean

opEquality(Point left, Point right)

public static boolean opEquality(Point left, Point right)

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are equal.

Parameters:

Parameter	Type	Description
left	Point	A Point to compare.
right	Point	A Point to compare.

Returns: boolean - true if the Point.X and Point.Y values of left and right are equal; otherwise, false.

opInequality(Point left, Point right)

public static boolean opInequality(Point left, Point right)

Compares two Point objects. The result specifies whether the values of the Point.X and Point.Y properties of the two Point objects are not equal.

Parameters:

Parameter	Type	Description
left	Point	A Point to compare.
right	Point	A Point to compare.

Returns: boolean - true if the Point.X and Point.Y values of left and right are not equal; otherwise, false.

equals(Point obj1, Point obj2)

public static boolean equals(Point obj1, Point obj2)

Parameters:

Parameter	Type	Description
obj1	Point
obj2	Point

Returns: boolean

getX()

public final float getX()

Gets or sets the x.

Value: The x.

Returns: float -

setX(float value)

public final void setX(float value)

Gets or sets the x.

Value: The x.

Parameters:

Parameter	Type	Description
value	float

getY()

public final float getY()

Gets or sets the y.

Value: The y.

Returns: float -

setY(float value)

public final void setY(float value)

Gets or sets the y.

Value: The y.

Parameters:

Parameter	Type	Description
value	float

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified point is equal to the current point.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The point to compare with the current point.

Returns: boolean - if the specified point is equal to the current point; otherwise, .

hashCode()

public int hashCode()

Serves as the default hash function.

Returns: int - A hash code for the current point.

toString()

public String toString()

Returns: java.lang.String

Java: Rectangle

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class Rectangle

Represents rectangle.

Constructors

Constructor	Description
Rectangle()
Rectangle(float x, float y, float width, float height)	Initializes a new instance of the Rectangle class.
Rectangle(Rectangle rectangle)	Initializes a new instance of Rectangle class.

Methods

Method	Description
opEquality(Rectangle left, Rectangle right)	Compares two Rectangle objects.
opInequality(Rectangle left, Rectangle right)	Compares two Rectangle objects.
equals(Rectangle obj1, Rectangle obj2)
getX()	Gets or sets the x.
setX(float value)	Gets or sets the x.
getY()	Gets or sets the y.
setY(float value)	Gets or sets the y.
getWidth()	Gets or sets the width.
setWidth(float value)	Gets or sets the width.
getHeight()	Gets or sets the height.
setHeight(float value)	Gets or sets the height.
equals(Object obj)	Determines whether the specified rectangle is equal to the current rectangle.
hashCode()	Serves as the default hash function.
toString()

Rectangle()

public Rectangle()

Rectangle(float x, float y, float width, float height)

public Rectangle(float x, float y, float width, float height)

Initializes a new instance of the Rectangle class.

Parameters:

Parameter	Type	Description
x	float	The x.
y	float	The y.
width	float	The width.
height	float	The height.

Rectangle(Rectangle rectangle)

public Rectangle(Rectangle rectangle)

Initializes a new instance of Rectangle class.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle.

opEquality(Rectangle left, Rectangle right)

public static boolean opEquality(Rectangle left, Rectangle right)

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are equal.

Parameters:

Parameter	Type	Description
left	Rectangle	A Rectangle to compare.
right	Rectangle	A Rectangle to compare.

Returns: boolean - true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are equal; otherwise, false.

opInequality(Rectangle left, Rectangle right)

public static boolean opInequality(Rectangle left, Rectangle right)

Compares two Rectangle objects. The result specifies whether the values of the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height properties of the two Rectangle objects are not equal.

Parameters:

Parameter	Type	Description
left	Rectangle	A Rectangle to compare.
right	Rectangle	A Rectangle to compare.

Returns: boolean - true if the Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values of left and right are not equal; otherwise, false.

equals(Rectangle obj1, Rectangle obj2)

public static boolean equals(Rectangle obj1, Rectangle obj2)

Parameters:

Parameter	Type	Description
obj1	Rectangle
obj2	Rectangle

Returns: boolean

getX()

public final float getX()

Gets or sets the x.

Value: The x.

Returns: float -

setX(float value)

public final void setX(float value)

Gets or sets the x.

Value: The x.

Parameters:

Parameter	Type	Description
value	float

getY()

public final float getY()

Gets or sets the y.

Value: The y.

Returns: float -

setY(float value)

public final void setY(float value)

Gets or sets the y.

Value: The y.

Parameters:

Parameter	Type	Description
value	float

getWidth()

public final float getWidth()

Gets or sets the width.

Value: The width.

Returns: float -

setWidth(float value)

public final void setWidth(float value)

Gets or sets the width.

Value: The width.

Parameters:

Parameter	Type	Description
value	float

getHeight()

public final float getHeight()

Gets or sets the height.

Value: The height.

Returns: float -

setHeight(float value)

public final void setHeight(float value)

Gets or sets the height.

Value: The height.

Parameters:

Parameter	Type	Description
value	float

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified rectangle is equal to the current rectangle.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The rectangle to compare with the current rectangle.

Returns: boolean - if the specified rectangle is equal to the current rectangle; otherwise, .

hashCode()

public int hashCode()

Serves as the default hash function.

Returns: int - A hash code for the current rectangle.

toString()

public String toString()

Returns: java.lang.String

Java: Reply

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.ms.System.ICloneable, java.lang.Cloneable

public class Reply implements System.ICloneable, Cloneable

Represents annotation reply.

Constructors

Constructor	Description
Reply()

Methods

Method	Description
getId()	Reply Id
setId(int value)	Reply Id
getUser()	Reply creator
setUser(User value)	Reply creator
getComment()	Reply comment
setComment(String value)	Reply comment
getRepliedOn()	Reply creation date
setRepliedOn(Date value)	Reply creation date
getParentReply()	Parent reply
setParentReply(Reply value)	Parent reply
deepClone()	Returns new Instance with same values
clone()
toString()

Reply()

public Reply()

getId()

public final int getId()

Reply Id

Returns: int -

setId(int value)

public final void setId(int value)

Reply Id

Parameters:

Parameter	Type	Description
value	int

getUser()

public final User getUser()

Reply creator

Returns: User -

setUser(User value)

public final void setUser(User value)

Reply creator

Parameters:

Parameter	Type	Description
value	User

getComment()

public final String getComment()

Reply comment

Returns: java.lang.String -

setComment(String value)

public final void setComment(String value)

Reply comment

Parameters:

Parameter	Type	Description
value	java.lang.String

getRepliedOn()

public final Date getRepliedOn()

Reply creation date

Returns: java.util.Date -

setRepliedOn(Date value)

public final void setRepliedOn(Date value)

Reply creation date

Parameters:

Parameter	Type	Description
value	java.util.Date

getParentReply()

public final Reply getParentReply()

Parent reply

Returns: Reply -

setParentReply(Reply value)

public final void setParentReply(Reply value)

Parent reply

Parameters:

Parameter	Type	Description
value	Reply

deepClone()

public final Object deepClone()

Returns new Instance with same values

Returns: java.lang.Object -

clone()

public Object clone()

Returns: java.lang.Object

toString()

public String toString()

Returns: java.lang.String

Java: User

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class User

Represents user properties.

Constructors

Constructor	Description
User()	Initializes new instance of User class.
User(int id, String name, Role role)	Initializes new instance of User class.

Methods

Method	Description
getId()	User Id
setId(int value)	User Id
getName()	User name
setName(String value)	User name
getEmail()	Email
setEmail(String value)	Email
getRole()	Role
setRole(Role value)	Role
toString()

User()

public User()

Initializes new instance of User class.

User(int id, String name, Role role)

public User(int id, String name, Role role)

Initializes new instance of User class.

Parameters:

Parameter	Type	Description
id	int	The user id.
name	java.lang.String	The user name.
role	Role	The user role.

getId()

public final int getId()

User Id

Returns: int -

setId(int value)

public final void setId(int value)

User Id

Parameters:

Parameter	Type	Description
value	int

getName()

public final String getName()

User name

Returns: java.lang.String -

setName(String value)

public final void setName(String value)

User name

Parameters:

Parameter	Type	Description
value	java.lang.String

getEmail()

public final String getEmail()

Returns: java.lang.String -

setEmail(String value)

public final void setEmail(String value)

Parameters:

Parameter	Type	Description
value	java.lang.String

getRole()

public final Role getRole()

Role

Returns: Role -

setRole(Role value)

public final void setRole(Role value)

Role

Parameters:

Parameter	Type	Description
value	Role

toString()

public String toString()

Returns: java.lang.String

Java: DocumentType

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, java.lang.Enum

public enum DocumentType extends Enum<DocumentType>

The annotation document type

Fields

Field	Description
UNDEFINED	The undefined
PDF	Represents Pdf format
CELLS	Represents Excel format
SLIDES	Represents Powerpoint format
WORDS	Represents Word format
IMAGES	Represents Image format
EMAIL	Represents Email format
HTML	Represents HTML format
DIAGRAM	Represents Diagram format

Methods

Method	Description
values()
valueOf(String name)

UNDEFINED

public static final DocumentType UNDEFINED

The undefined

PDF

public static final DocumentType PDF

Represents Pdf format

CELLS

public static final DocumentType CELLS

Represents Excel format

SLIDES

public static final DocumentType SLIDES

Represents Powerpoint format

WORDS

public static final DocumentType WORDS

Represents Word format

IMAGES

public static final DocumentType IMAGES

Represents Image format

EMAIL

public static final DocumentType EMAIL

Represents Email format

HTML

public static final DocumentType HTML

Represents HTML format

DIAGRAM

public static final DocumentType DIAGRAM

Represents Diagram format

values()

public static DocumentType[] values()

Returns: com.groupdocs.annotation.models.DocumentType[]

valueOf(String name)

public static DocumentType valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: DocumentType