Groupdocs API References – com.groupdocs.signature.domain.stamps

Nodejs-Java: Corners

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

Inheritance: java.lang.Object

public class Corners

Represents corners of a square graphical object.

Constructors

Constructor	Description
Corners()	Initializes a new instance of Corners class using zero values.
Corners(double all)	Initializes a new instance of the Corners class using the supplied value for all corners.
Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)	Initializes a new instance of the Corners class using the supplied values.

Fields

Field	Description
Empty	Provides a Corners object with no data.

Methods

Method	Description
getAll()	Gets or sets the value for all corners.
setAll(double value)	Gets or sets the value for all corners.
getTopLeft()	Gets or sets top left corner value.
setTopLeft(double value)	Gets or sets top left corner value.
getTopRight()	Gets or sets top right corner value.
setTopRight(double value)	Gets or sets top right corner value.
getBottomLeft()	Gets or sets bottom left corner value.
setBottomLeft(double value)	Gets or sets bottom left corner value.
getBottomRight()	Gets or sets bottom right corner value.
setBottomRight(double value)	Gets or sets bottom right corner value.
deepClone()	Gets a copy of this object.
equals(Object obj)	Override equals method
hashCode()	Overrides obtaining unique hash code value
toString()	Overrides conversion to string.

Corners()

public Corners()

Initializes a new instance of Corners class using zero values.

Corners(double all)

public Corners(double all)

Initializes a new instance of the Corners class using the supplied value for all corners.

Parameters:

Parameter	Type	Description
all	double	The value to be used for padding for all corners.

Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)

public Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)

Initializes a new instance of the Corners class using the supplied values.

Parameters:

Parameter	Type	Description
topLeft	double	Top left corner value.
topRight	double	Top right corner value.
bottomLeft	double	Bottom left corner value.
bottomRight	double	Bottom right corner value.

Empty

public static final Corners Empty

Provides a Corners object with no data.

getAll()

public final double getAll()

Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;

Returns: double

setAll(double value)

public final void setAll(double value)

Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;

Parameters:

Parameter	Type	Description
value	double

getTopLeft()

public final double getTopLeft()

Gets or sets top left corner value.

Returns: double

setTopLeft(double value)

public final void setTopLeft(double value)

Gets or sets top left corner value.

Parameters:

Parameter	Type	Description
value	double

getTopRight()

public final double getTopRight()

Gets or sets top right corner value.

Returns: double

setTopRight(double value)

public final void setTopRight(double value)

Gets or sets top right corner value.

Parameters:

Parameter	Type	Description
value	double

getBottomLeft()

public final double getBottomLeft()

Gets or sets bottom left corner value.

Returns: double

setBottomLeft(double value)

public final void setBottomLeft(double value)

Gets or sets bottom left corner value.

Parameters:

Parameter	Type	Description
value	double

getBottomRight()

public final double getBottomRight()

Gets or sets bottom right corner value.

Returns: double

setBottomRight(double value)

public final void setBottomRight(double value)

Gets or sets bottom right corner value.

Parameters:

Parameter	Type	Description
value	double

deepClone()

public final Object deepClone()

Gets a copy of this object.

Returns: java.lang.Object

equals(Object obj)

public boolean equals(Object obj)

Override equals method

Parameters:

Parameter	Type	Description
obj	java.lang.Object	Instance to compare with.

Returns: boolean - Returns true if properties of objects are equal.

hashCode()

public int hashCode()

Overrides obtaining unique hash code value

Returns: int -

toString()

public String toString()

Overrides conversion to string.

Returns: java.lang.String -

Nodejs-Java: SquareBorder

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

Inheritance: java.lang.Object, com.groupdocs.signature.domain.Border

public class SquareBorder extends Border

Instance to keep Border line properties for square stamp line.

Constructors

Constructor	Description
SquareBorder(double radius)	Creates SquareBorderLine with rounded corner radius.
SquareBorder(Corners corners)	Creates SquareBorderLine with corner radius values.

Methods

Method	Description
getRadius()	Gets or sets the radius of square corners.
setRadius(Corners value)	Gets or sets the radius of square corners.

SquareBorder(double radius)

public SquareBorder(double radius)

Creates SquareBorderLine with rounded corner radius.

Parameters:

Parameter	Type	Description
radius	double	Radius of square corners.

SquareBorder(Corners corners)

public SquareBorder(Corners corners)

Creates SquareBorderLine with corner radius values.

Parameters:

Parameter	Type	Description
corners	Corners	Radius of square corners.

getRadius()

public final Corners getRadius()

Gets or sets the radius of square corners.

Returns: Corners

setRadius(Corners value)

public final void setRadius(Corners value)

Gets or sets the radius of square corners.

Parameters:

Parameter	Type	Description
value	Corners

Nodejs-Java: StampBackgroundCropType

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

Inheritance: java.lang.Object

public final class StampBackgroundCropType

Specifies crop type of background layer on Stamp elements.

Fields

Field	Description
None	No crop - all Signature area rectangle will be filled with background.
OuterArea	Crop background by external outer line.
MiddleArea	Crop background between external and inner lines.
InnerArea	Crop background by internal line.

None

public static final int None

No crop - all Signature area rectangle will be filled with background.

OuterArea

public static final int OuterArea

Crop background by external outer line.

MiddleArea

public static final int MiddleArea

Crop background between external and inner lines.

InnerArea

public static final int InnerArea

Crop background by internal line.

Nodejs-Java: StampLine

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

Inheritance: java.lang.Object

public class StampLine

Specify Stamp line properties.

Constructors

Constructor	Description
StampLine()	Create StampLine with default values.
StampLine(String text)	Create StampLine with text.

Methods

Method	Description
getHeight()	Gets or sets the line height on Stamp.
setHeight(int value)	Gets or sets the line height on Stamp.
getBackgroundColor()	Gets or sets the background color of signature.
setBackgroundColor(Color value)	Gets or sets the background color of signature.
setBackgroundColor(String value)	Gets or sets the background color of signature.
getText()	Gets or sets the text of stamp line.
setText(String value)	Gets or sets the text of stamp line.
getFont()	Get or set Font of Stamp Line text.
setFont(SignatureFont value)	Get or set Font of Stamp Line text.
getTextColor()	Gets or sets the text color of signature.
setTextColor(Color value)	Gets or sets the text color of signature.
setTextColor(String value)	Gets or sets the text color of signature.
getTextBottomIntent()	Gets or sets the bottom intent of text.
setTextBottomIntent(int value)	Gets or sets the bottom intent of text.
getTextRepeatType()	Gets or sets text repeat type.
setTextRepeatType(int value)	Gets or sets text repeat type.
getOuterBorder()	Setup Outer Border.
setOuterBorder(Border value)	Setup Outer Border.
getInnerBorder()	Setup Internal Border.
setInnerBorder(Border value)	Setup Internal Border.
getVisible()	Get and set visibility of Stamp Line.
setVisible(boolean value)	Get and set visibility of Stamp Line.

StampLine()

public StampLine()

Create StampLine with default values.

StampLine(String text)

public StampLine(String text)

Create StampLine with text.

Parameters:

Parameter	Type	Description
text	java.lang.String	Text of Stamp Line.

getHeight()

public final int getHeight()

Gets or sets the line height on Stamp.

Returns: int

setHeight(int value)

public final void setHeight(int value)

Gets or sets the line height on Stamp.

Parameters:

Parameter	Type	Description
value	int

getBackgroundColor()

public final Color getBackgroundColor()

Gets or sets the background color of signature.

Returns: java.awt.Color

setBackgroundColor(Color value)

public final void setBackgroundColor(Color value)

Gets or sets the background color of signature.

Parameters:

Parameter	Type	Description
value	java.awt.Color

setBackgroundColor(String value)

public final void setBackgroundColor(String value)

Gets or sets the background color of signature.

Parameters:

Parameter	Type	Description
value	java.lang.String

getText()

public final String getText()

Gets or sets the text of stamp line.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Gets or sets the text of stamp line.

Parameters:

Parameter	Type	Description
value	java.lang.String

getFont()

public final SignatureFont getFont()

Get or set Font of Stamp Line text.

Returns: SignatureFont

setFont(SignatureFont value)

public final void setFont(SignatureFont value)

Get or set Font of Stamp Line text.

Parameters:

Parameter	Type	Description
value	SignatureFont

getTextColor()

public final Color getTextColor()

Gets or sets the text color of signature.

Returns: java.awt.Color

setTextColor(Color value)

public final void setTextColor(Color value)

Gets or sets the text color of signature.

Parameters:

Parameter	Type	Description
value	java.awt.Color

setTextColor(String value)

public final void setTextColor(String value)

Gets or sets the text color of signature.

Parameters:

Parameter	Type	Description
value	java.lang.String

getTextBottomIntent()

public final int getTextBottomIntent()

Gets or sets the bottom intent of text.

Returns: int

setTextBottomIntent(int value)

public final void setTextBottomIntent(int value)

Gets or sets the bottom intent of text.

Parameters:

Parameter	Type	Description
value	int

getTextRepeatType()

public final int getTextRepeatType()

Gets or sets text repeat type.

Returns: int

setTextRepeatType(int value)

public final void setTextRepeatType(int value)

Gets or sets text repeat type.

Parameters:

Parameter	Type	Description
value	int

getOuterBorder()

public final Border getOuterBorder()

Setup Outer Border.

Returns: Border

setOuterBorder(Border value)

public final void setOuterBorder(Border value)

Setup Outer Border.

Parameters:

Parameter	Type	Description
value	Border

getInnerBorder()

public final Border getInnerBorder()

Setup Internal Border.

Returns: Border

setInnerBorder(Border value)

public final void setInnerBorder(Border value)

Setup Internal Border.

Parameters:

Parameter	Type	Description
value	Border

getVisible()

public final boolean getVisible()

Get and set visibility of Stamp Line.

Returns: boolean

setVisible(boolean value)

public final void setVisible(boolean value)

Get and set visibility of Stamp Line.

Parameters:

Parameter	Type	Description
value	boolean

Nodejs-Java: StampTextRepeatType

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

Inheritance: java.lang.Object

public final class StampTextRepeatType

Specifies type of text repeat for stamp lines.

Fields

Field	Description
None	No repeat.
FullTextRepeat	Text will be repeated to fit full length without truncation.
RepeatWithTruncation	Text will be repeated to fit full length with word truncation at the end.

None

public static final int None

No repeat.

FullTextRepeat

public static final int FullTextRepeat

Text will be repeated to fit full length without truncation.

RepeatWithTruncation

public static final int RepeatWithTruncation

Text will be repeated to fit full length with word truncation at the end.

Nodejs-Java: StampType

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

Inheritance: java.lang.Object

public final class StampType

Specify stamp type properties.

Methods

Method	Description
getTypeIndex()	Get Index of object in collection of supported stamp types.
getTypeName()	Name of stamp type.
equals(StampType other)	Determines whether the specified stamp type is equal to the current object.
hashCode()	Overridden method serves as a hash function for a particular type.
toString()	Overridden method serves as conversion to string type.

getTypeIndex()

public final int getTypeIndex()

Get Index of object in collection of supported stamp types.

Returns: int

getTypeName()

public final String getTypeName()

Name of stamp type.

Returns: java.lang.String

equals(StampType other)

public final boolean equals(StampType other)

Determines whether the specified stamp type is equal to the current object.

Parameters:

Parameter	Type	Description
other	StampType	Object for comparison.

Returns: boolean - Result of comparison.

hashCode()

public int hashCode()

Overridden method serves as a hash function for a particular type.

Returns: int - Hash.

toString()

public String toString()

Overridden method serves as conversion to string type.

Returns: java.lang.String - String.

Nodejs-Java: StampTypes

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

Inheritance: java.lang.Object

public class StampTypes

Stamp types container.

Constructors

Constructor	Description
StampTypes()

Fields

Field	Description
Round	Round stamp type object.
Square	Square stamp type object.

Methods

Method	Description
getAllTypes()	All stamp types.
parse(String parsingType)	Returns stamp type with pasringType name.
tryParse(String parsingType)	Returns stamp type with pasringType name.

StampTypes()

public StampTypes()

Round

public static final StampType Round

Round stamp type object.

Square

public static final StampType Square

Square stamp type object.

getAllTypes()

public static StampType[] getAllTypes()

All stamp types.

Returns: com.groupdocs.signature.domain.stamps.StampType[]

parse(String parsingType)

public static StampType parse(String parsingType)

Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown.

Parameters:

Parameter	Type	Description
parsingType	java.lang.String	Source string of stamp type name.

Returns: StampType - StampType instance.

tryParse(String parsingType)

public static StampType tryParse(String parsingType)

Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value.

Parameters:

Parameter	Type	Description
parsingType	java.lang.String	Source string of stamp type name.

Returns: StampType - StampType instance.