Namespace EasyXLS.Drawings.Formatting

Class LineStyleFormat

System.Object

EasyXLS.Drawings.Formatting.LineStyleFormat

public class LineStyleFormat
extends System.Object

This class stores the line style options for images, shapes and other drawing objects. The line style is defined by width, compound type, dash type, cap type, join type and rounded corners properties.

Constant Summary

Fields

Modifier and Type	Field	Description
const System.String	ARROW_TYPE_DIAMOND	A constant indicating the diamond arrow type.
const System.String	ARROW_TYPE_NONE	A constant indicating that no arrow is set.
const System.String	ARROW_TYPE_OPEN	A constant indicating the open arrow type.
const System.String	ARROW_TYPE_OVAL	A constant indicating the oval arrow type.
const System.String	ARROW_TYPE_STEALTH	A constant indicating the stealth arrow type.
const System.String	ARROW_TYPE_TRIANGLE	A constant indicating the triangle arrow type.
const System.String	CAP_TYPE_FLAT	A constant indicating the flat cap type.
const System.String	CAP_TYPE_ROUND	A constant indicating the round cap type.
const System.String	CAP_TYPE_SQUARE	A constant indicating the square cap type.
const System.String	COMPOUND_TYPE_DOUBLE	A constant indicating the double compound type.
const System.String	COMPOUND_TYPE_NONE	A constant indicating that no compound type is set.
const System.String	COMPOUND_TYPE_SIMPLE	A constant indicating the simple compound type.
const System.String	COMPOUND_TYPE_THICK_THIN	A constant indicating the thick thin compound type.
const System.String	COMPOUND_TYPE_THIN_THICK	A constant indicating the thin thick compound type.
const System.String	COMPOUND_TYPE_TRIPLE	A constant indicating the triple compound type.
const System.String	DASH_TYPE_DASH	A constant indicating the dash dash type.
const System.String	DASH_TYPE_DASH_DOT	A constant indicating the dash dot dash type.
const System.String	DASH_TYPE_LONG_DASH	A constant indicating the long dash dash type.
const System.String	DASH_TYPE_LONG_DASH_DOT	A constant indicating the long dash dot dash type.
const System.String	DASH_TYPE_LONG_DASH_DOT_DOT	A constant indicating the long dash dot dot dash type.
const System.String	DASH_TYPE_ROUND_DOT	A constant indicating the round dot dash type.
const System.String	DASH_TYPE_SOLID	A constant indicating the solid dash type.
const System.String	DASH_TYPE_SQUARE_DOT	A constant indicating the square dot dash type.
const System.String	JOIN_TYPE_BEVEL	A constant indicating the bevel join type.
const System.String	JOIN_TYPE_MITER	A constant indicating the miter join type.
const System.String	JOIN_TYPE_ROUND	A constant indicating the round join type.

Constructor Summary

Constructors

Constructor	Description
LineStyleFormat()	Defines an instance of the line style formatting.

Method Summary

Modifier and Type	Method	Description
LineStyleFormat	Clone()	Creates and returns a copy of this object.
int	getArrowBeginSize()	Returns the begin size of the arrow.
System.String	getArrowBeginType()	Returns the begin type of the arrow.
int	getArrowEndSize()	Returns the end size of the arrow.
System.String	getArrowEndType()	Returns the end type of the arrow.
System.String	getCapType()	Returns the cap type of the line.
System.String	getCompoundType()	Returns the compound type of the line.
System.String	getDashType()	Returns the dash type of the line.
System.String	getJoinType()	Returns the join type of the line.
float	getWidth()	Returns the width of the line.
void	setArrowSettings(System.String arrowBeginType, int arrowBeginSize, System.String arrowEndType, int arrowEndSize)	Sets the arrow options of the line.
void	setCapType(System.String capType)	Sets the cap type of the line.
void	setCompoundType(System.String compoundType)	Sets the compound type of the line.
void	setDashType(System.String dashType)	Sets the dash type of the line.
void	setJoinType(System.String joinType)	Sets the join type of the line.
void	setWidth(float width)	Sets the width of the line.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPOUND_TYPE_NONE

public const final System.String COMPOUND_TYPE_NONE

A constant indicating that no compound type is set. Embedded value is "none".

See Also:

• Constant Values

COMPOUND_TYPE_SIMPLE

public const final System.String COMPOUND_TYPE_SIMPLE

A constant indicating the simple compound type. Embedded value is "sng".

See Also:

• Constant Values

COMPOUND_TYPE_DOUBLE

public const final System.String COMPOUND_TYPE_DOUBLE

A constant indicating the double compound type. Embedded value is "dbl".

See Also:

• Constant Values

COMPOUND_TYPE_THICK_THIN

public const final System.String COMPOUND_TYPE_THICK_THIN

A constant indicating the thick thin compound type. Embedded value is "thickThin".

See Also:

• Constant Values

COMPOUND_TYPE_THIN_THICK

public const final System.String COMPOUND_TYPE_THIN_THICK

A constant indicating the thin thick compound type. Embedded value is "thinThick".

See Also:

• Constant Values

COMPOUND_TYPE_TRIPLE

public const final System.String COMPOUND_TYPE_TRIPLE

A constant indicating the triple compound type. Embedded value is "tri".

See Also:

• Constant Values

DASH_TYPE_SOLID

public const final System.String DASH_TYPE_SOLID

A constant indicating the solid dash type. Embedded value is "solid".

See Also:

• Constant Values

DASH_TYPE_ROUND_DOT

public const final System.String DASH_TYPE_ROUND_DOT

A constant indicating the round dot dash type. Embedded value is "sysDot".

See Also:

• Constant Values

DASH_TYPE_SQUARE_DOT

public const final System.String DASH_TYPE_SQUARE_DOT

A constant indicating the square dot dash type. Embedded value is "sysDash".

See Also:

• Constant Values

DASH_TYPE_DASH

public const final System.String DASH_TYPE_DASH

A constant indicating the dash dash type. Embedded value is "dash".

See Also:

• Constant Values

DASH_TYPE_DASH_DOT

public const final System.String DASH_TYPE_DASH_DOT

A constant indicating the dash dot dash type. Embedded value is "dashDot".

See Also:

• Constant Values

DASH_TYPE_LONG_DASH

public const final System.String DASH_TYPE_LONG_DASH

A constant indicating the long dash dash type. Embedded value is "lgDash".

See Also:

• Constant Values

DASH_TYPE_LONG_DASH_DOT

public const final System.String DASH_TYPE_LONG_DASH_DOT

A constant indicating the long dash dot dash type. Embedded value is "lgDashDot".

See Also:

• Constant Values

DASH_TYPE_LONG_DASH_DOT_DOT

public const final System.String DASH_TYPE_LONG_DASH_DOT_DOT

A constant indicating the long dash dot dot dash type. Embedded value is "lgDashDotDot".

See Also:

• Constant Values

CAP_TYPE_SQUARE

public const final System.String CAP_TYPE_SQUARE

A constant indicating the square cap type. Embedded value is "sq".

See Also:

• Constant Values

CAP_TYPE_ROUND

public const final System.String CAP_TYPE_ROUND

A constant indicating the round cap type. Embedded value is "rnd".

See Also:

• Constant Values

CAP_TYPE_FLAT

public const final System.String CAP_TYPE_FLAT

A constant indicating the flat cap type. Embedded value is "flat".

See Also:

• Constant Values

JOIN_TYPE_ROUND

public const final System.String JOIN_TYPE_ROUND

A constant indicating the round join type. Embedded value is "round".

See Also:

• Constant Values

JOIN_TYPE_BEVEL

public const final System.String JOIN_TYPE_BEVEL

A constant indicating the bevel join type. Embedded value is "bevel".

See Also:

• Constant Values

JOIN_TYPE_MITER

public const final System.String JOIN_TYPE_MITER

A constant indicating the miter join type. Embedded value is "miter".

See Also:

• Constant Values

ARROW_TYPE_NONE

public const final System.String ARROW_TYPE_NONE

A constant indicating that no arrow is set. Embedded value is "none".

See Also:

• Constant Values

ARROW_TYPE_TRIANGLE

public const final System.String ARROW_TYPE_TRIANGLE

A constant indicating the triangle arrow type. Embedded value is "triangle".

See Also:

• Constant Values

ARROW_TYPE_OPEN

public const final System.String ARROW_TYPE_OPEN

A constant indicating the open arrow type. Embedded value is "arrow".

See Also:

• Constant Values

ARROW_TYPE_STEALTH

public const final System.String ARROW_TYPE_STEALTH

A constant indicating the stealth arrow type. Embedded value is "stealth".

See Also:

• Constant Values

ARROW_TYPE_DIAMOND

public const final System.String ARROW_TYPE_DIAMOND

A constant indicating the diamond arrow type. Embedded value is "diamond".

See Also:

• Constant Values

ARROW_TYPE_OVAL

public const final System.String ARROW_TYPE_OVAL

A constant indicating the oval arrow type. Embedded value is "oval".

See Also:

• Constant Values

Constructor Details

LineStyleFormat

public LineStyleFormat()

Defines an instance of the line style formatting.

Method Details

getWidth

public float getWidth()

Returns the width of the line.

Returns:

the width of the line

See Also:

• setWidth(float)
• getCompoundType()
• getDashType()

setWidth

public void setWidth(float width)

Sets the width of the line.

Parameters:

width - the width of the line

See Also:

• getWidth()
• setCompoundType(System.String)
• setDashType(System.String)

getCompoundType

public System.String getCompoundType()

Returns the compound type of the line. Possible values are available in LineStyleFormat class.

Returns:

the compound type of the line

See Also:

• setCompoundType(System.String)
• getWidth()
• getDashType()

setCompoundType

public void setCompoundType(System.String compoundType)

Sets the compound type of the line. Possible values are available in LineStyleFormat class.

Parameters:

compoundType - the compound type of the line

See Also:

• getCompoundType()
• setWidth(float)
• setDashType(System.String)

getDashType

public System.String getDashType()

Returns the dash type of the line. Possible values are available in LineStyleFormat class.

Returns:

the dash type of the line

See Also:

• setDashType(System.String)
• getWidth()
• getCompoundType()

setDashType

public void setDashType(System.String dashType)

Sets the dash type of the line. Possible values are available in LineStyleFormat class.

Parameters:

dashType - the dash type of the line

See Also:

• getDashType()
• setWidth(float)
• setCompoundType(System.String)

getCapType

public System.String getCapType()

Returns the cap type of the line. Possible values are available in LineStyleFormat class.

Returns:

the cap type of the line

See Also:

• setCapType(System.String)
• getJoinType()

setCapType

public void setCapType(System.String capType)

Sets the cap type of the line. Possible values are available in LineStyleFormat class.

Parameters:

capType - the cap type of the line

See Also:

• getCapType()
• setJoinType(System.String)

getJoinType

public System.String getJoinType()

Returns the join type of the line. Possible values are available in LineStyleFormat class.

Returns:

the join type of the line

See Also:

• setJoinType(System.String)
• getCapType()

setJoinType

public void setJoinType(System.String joinType)

Sets the join type of the line. Possible values are available in LineStyleFormat class.

Parameters:

joinType - the join type of the line

See Also:

• getJoinType()
• setCapType(System.String)

setArrowSettings

public void setArrowSettings(System.String arrowBeginType,
 int arrowBeginSize,
 System.String arrowEndType,
 int arrowEndSize)

Sets the arrow options of the line.

Parameters:

arrowBeginType - the begin type of the arrow. Possible values are available in LineStyleFormat class.

arrowBeginSize - the begin size of the arrow.

arrowEndType - the end type of the arrow. Possible values are available in LineStyleFormat class.

arrowEndSize - the end size of the arrow.

See Also:

• getArrowBeginType()
• getArrowBeginSize()
• getArrowEndType()
• getArrowEndSize()

getArrowBeginType

public System.String getArrowBeginType()

Returns the begin type of the arrow. Possible values are available in LineStyleFormat class.

Returns:

the begin type of the arrow

See Also:

• setArrowSettings(System.String, int, System.String, int)
• getArrowBeginSize()
• getArrowEndType()
• getArrowEndSize()

getArrowBeginSize

public int getArrowBeginSize()

Returns the begin size of the arrow.

Returns:

the begin size of the arrow

See Also:

• setArrowSettings(System.String, int, System.String, int)
• getArrowBeginType()
• getArrowEndType()
• getArrowEndSize()

getArrowEndType

public System.String getArrowEndType()

Returns the end type of the arrow. Possible values are available in LineStyleFormat class.

Returns:

the end type of the arrow

See Also:

• setArrowSettings(System.String, int, System.String, int)
• getArrowBeginType()
• getArrowBeginSize()
• getArrowEndSize()

getArrowEndSize

public int getArrowEndSize()

Returns the end size of the arrow.

Returns:

the end size of the arrow

See Also:

• setArrowSettings(System.String, int, System.String, int)
• getArrowBeginType()
• getArrowBeginSize()
• getArrowEndType()

Clone

public LineStyleFormat Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.