Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]
public static class

# Annot.BorderStyle

extends Object
implements AutoCloseable

java.lang.Object
↳ | com.pdftron.pdf.Annot.BorderStyle

## Class Overview

BorderStyle structure specifies the characteristics of the annotation's border. The border is specified as a rounded rectangle.

## Summary

Constants
int | e_beveled | The Constant e_beveled.
int | e_dashed | The Constant e_dashed.
int | e_inset | The Constant e_inset.
int | e_solid | The border style options.
int | e_underline | The Constant e_underline.

Public Constructors
| BorderStyle(int s, int b_width, int b_hr, int b_vr) Creates a new border style with given parameters.
| BorderStyle(int s, int b_width, int b_hr, int b_vr, double[] b_dash) Creates a new border style with given parameters.

Public Methods
void | close() Frees the native memory of the object.
void | destroy() Frees the native memory of the object.
double[] | getDash() Get the dash.
int | getHR() Get the hR.
int | getStyle() Get the style.
int | getVR() Get the vR.
double | getWidth() Get the width.
void | setDash(double[] dash) Set the border dash pattern.
void | setHR(int hr) Set horizontal corner radius.
void | setStyle(int style) Set the border style.
void | setVR(int vr) Set vertical corner radius.
void | setWidth(double width) Set the border width.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()
From interface java.lang.AutoCloseable
abstract void | close()

## Constants

#### public static final int e_beveled

The Constant e_beveled.

Constant Value: 2 (0x00000002)

#### public static final int e_dashed

The Constant e_dashed.

Constant Value: 1 (0x00000001)

#### public static final int e_inset

The Constant e_inset.

Constant Value: 3 (0x00000003)

#### public static final int e_solid

The border style options.

Constant Value: 0 (0x00000000)

#### public static final int e_underline

The Constant e_underline.

Constant Value: 4 (0x00000004)

## Public Constructors

#### public BorderStyle (int s, int b_width, int b_hr, int b_vr)

Creates a new border style with given parameters.

Note: If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

##### Parameters

s | The border style.
b_width | The border width expressed in the default user space.
b_hr | The horizontal corner radius expressed in the default user space.
b_vr | The vertical corner radius expressed in the default user space. in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.

##### Throws

PDFNetException |

#### public BorderStyle (int s, int b_width, int b_hr, int b_vr, double[] b_dash)

Creates a new border style with given parameters.

Note: If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

##### Parameters

s | The border style.
b_width | The border width expressed in the default user space.
b_hr | The horizontal corner radius expressed in the default user space.
b_vr | The vertical corner radius expressed in the default user space.
b_dash | An array of numbers defining a pattern of dashes and gaps to be used in drawing the border. The dash array is specified in the same format as in the line dash pattern parameter of the graphics state except that the phase is assumed to be 0.

##### Throws

PDFNetException |

## Public Methods

#### public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

##### Throws

PDFNetException |

#### public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

##### Throws

PDFNetException |

#### public double[] getDash ()

Get the dash.

##### Returns

- the border dash pattern.

##### Throws

PDFNetException |

#### public int getHR ()

Get the hR.

##### Returns

- horizontal corner radius.

##### Throws

PDFNetException |

#### public int getStyle ()

Get the style.

##### Returns

- the border style.

##### Throws

PDFNetException |

#### public int getVR ()

Get the vR.

##### Returns

- vertical corner radius.

##### Throws

PDFNetException |

#### public double getWidth ()

Get the width.

##### Returns

- the border width.

##### Throws

PDFNetException |

#### public void setDash (double[] dash)

Set the border dash pattern.

##### Parameters

dash | the new dash

##### Throws

PDFNetException |

#### public void setHR (int hr)

Set horizontal corner radius.

##### Parameters

hr | the new hR

##### Throws

PDFNetException |

#### public void setStyle (int style)

Set the border style.

##### Parameters

style | the new style

##### Throws

PDFNetException |

#### public void setVR (int vr)

Set vertical corner radius.

##### Parameters

vr | the new vR

##### Throws

PDFNetException |

#### public void setWidth (double width)

Set the border width.

##### Parameters

width | the new width

##### Throws

PDFNetException |