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

# RefreshOptions

extends OptionsBase

java.lang.Object
↳ | com.pdftron.pdf.OptionsBase
| ↳ | com.pdftron.pdf.RefreshOptions

## Summary

Public Constructors
| RefreshOptions() Constructor.
| RefreshOptions(String json_string) Constructor.

Public Methods
boolean | getDrawBackgroundOnly() Gets the value DrawBackgroundOnly from the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere.
boolean | getRefreshExisting() Gets the value RefreshExisting from the options object Whether we should refresh annotations with existing appearances.
boolean | getUseNonStandardRotation() Gets the value UseNonStandardRotation from the options object Whether we should use rotation in the annotation even if it is not a multiple of 90.
boolean | getUseRoundedCorners() Gets the value UseRoundedCorners from the options object Whether we should use the corner radii specified in Annot.BorderStyle.
RefreshOptions | setDrawBackgroundOnly(boolean value) Sets the value for DrawBackgroundOnly in the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere.
RefreshOptions | setRefreshExisting(boolean value) Sets the value for RefreshExisting in the options object Whether we should refresh annotations with existing appearances.
RefreshOptions | setUseNonStandardRotation(boolean value) Sets the value for UseNonStandardRotation in the options object Whether we should use rotation in the annotation even if it is not a multiple of 90.
RefreshOptions | setUseRoundedCorners(boolean value) Sets the value for UseRoundedCorners in the options object Whether we should use the corner radii specified in Annot.BorderStyle.

[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()

## Public Constructors

#### public RefreshOptions ()

Constructor.

##### Throws

PDFNetException |

#### public RefreshOptions (String json_string)

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public boolean getDrawBackgroundOnly ()

Gets the value DrawBackgroundOnly from the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere. Off by default.

##### Returns

- the current value for DrawBackgroundOnly.

##### Throws

PDFNetException |

#### public boolean getRefreshExisting ()

Gets the value RefreshExisting from the options object Whether we should refresh annotations with existing appearances. Defaults to false when used in PDFDoc.RefreshAnnotAppearances and true when used in Annot.RefreshAppearance.

##### Returns

- the current value for RefreshExisting.

##### Throws

PDFNetException |

#### public boolean getUseNonStandardRotation ()

Gets the value UseNonStandardRotation from the options object Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

##### Returns

- the current value for UseNonStandardRotation.

##### Throws

PDFNetException |

#### public boolean getUseRoundedCorners ()

Gets the value UseRoundedCorners from the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.

##### Returns

- the current value for UseRoundedCorners.

##### Throws

PDFNetException |

#### public RefreshOptions setDrawBackgroundOnly (boolean value)

Sets the value for DrawBackgroundOnly in the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere. Off by default.

##### Parameters

value | the new value for DrawBackgroundOnly.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public RefreshOptions setRefreshExisting (boolean value)

Sets the value for RefreshExisting in the options object Whether we should refresh annotations with existing appearances. Defaults to false when used in PDFDoc.RefreshAnnotAppearances and true when used in Annot.RefreshAppearance.

##### Parameters

value | the new value for RefreshExisting.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public RefreshOptions setUseNonStandardRotation (boolean value)

Sets the value for UseNonStandardRotation in the options object Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.

##### Parameters

value | the new value for UseNonStandardRotation.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public RefreshOptions setUseRoundedCorners (boolean value)

Sets the value for UseRoundedCorners in the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.

##### Parameters

value | the new value for UseRoundedCorners.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |