public class LoadOptions extends java.lang.Object implements ILoadOptions
Allows to specify additional options (such as format or default font) when loading a presentation.
Constructor and Description |
---|
LoadOptions()
Creates new default load options.
|
LoadOptions(int loadFormat)
Creates new load options.
|
Modifier and Type | Method and Description |
---|---|
IBlobManagementOptions |
getBlobManagementOptions()
Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior,
such as using of temporary files or max BLOBs bytes in memory.
|
java.lang.String |
getDefaultAsianFont()
Returns or sets Asian font used in case source font is not found.
|
java.lang.String |
getDefaultRegularFont()
Returns or sets Regular font used in case source font is not found.
|
java.lang.String |
getDefaultSymbolFont()
Returns or sets Symbol font used in case source font is not found.
|
IFontSources |
getDocumentLevelFontSources()
Specifies sources for external fonts to be used by the presentation.
|
IInterruptionToken |
getInterruptionToken()
The token to monitor for interruption requests.
|
int |
getLoadFormat()
Returns or sets format of a presentation to load.
|
boolean |
getOnlyLoadDocumentProperties()
This property makes sense, if presentation file is password protected.
|
java.lang.String |
getPassword()
Gets or sets the password.
|
IResourceLoadingCallback |
getResourceLoadingCallback()
Returns or sets callback interface which manages external resources loading.
|
IWarningCallback |
getWarningCallback()
Returns or sets an object which receives warnings and decides whether loading
process will continue or will be aborted.
|
void |
setBlobManagementOptions(IBlobManagementOptions value)
Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior,
such as using of temporary files or max BLOBs bytes in memory.
|
void |
setDefaultAsianFont(java.lang.String value)
Returns or sets Asian font used in case source font is not found.
|
void |
setDefaultRegularFont(java.lang.String value)
Returns or sets Regular font used in case source font is not found.
|
void |
setDefaultSymbolFont(java.lang.String value)
Returns or sets Symbol font used in case source font is not found.
|
void |
setDocumentLevelFontSources(IFontSources value)
Specifies sources for external fonts to be used by the presentation.
|
void |
setInterruptionToken(IInterruptionToken value)
The token to monitor for interruption requests.
|
void |
setLoadFormat(int value)
Returns or sets format of a presentation to load.
|
void |
setOnlyLoadDocumentProperties(boolean value)
This property makes sense, if presentation file is password protected.
|
void |
setPassword(java.lang.String value)
Gets or sets the password.
|
void |
setResourceLoadingCallback(IResourceLoadingCallback value)
Returns or sets callback interface which manages external resources loading.
|
void |
setWarningCallback(IWarningCallback value)
Returns or sets an object which receives warnings and decides whether loading
process will continue or will be aborted.
|
public LoadOptions()
Creates new default load options.
public LoadOptions(int loadFormat)
Creates new load options.
loadFormat
- Format of a presentation to load.public final int getLoadFormat()
Returns or sets format of a presentation to load.
Read/write LoadFormat
.
getLoadFormat
in interface ILoadOptions
public final void setLoadFormat(int value)
Returns or sets format of a presentation to load.
Read/write LoadFormat
.
setLoadFormat
in interface ILoadOptions
public final java.lang.String getDefaultRegularFont()
Returns or sets Regular font used in case source font is not found.
Read/write String
.
getDefaultRegularFont
in interface ILoadOptions
public final void setDefaultRegularFont(java.lang.String value)
Returns or sets Regular font used in case source font is not found.
Read/write String
.
setDefaultRegularFont
in interface ILoadOptions
public final java.lang.String getDefaultSymbolFont()
Returns or sets Symbol font used in case source font is not found.
Read/write String
.
getDefaultSymbolFont
in interface ILoadOptions
public final void setDefaultSymbolFont(java.lang.String value)
Returns or sets Symbol font used in case source font is not found.
Read/write String
.
setDefaultSymbolFont
in interface ILoadOptions
public final java.lang.String getDefaultAsianFont()
Returns or sets Asian font used in case source font is not found.
Read/write String
.
getDefaultAsianFont
in interface ILoadOptions
public final void setDefaultAsianFont(java.lang.String value)
Returns or sets Asian font used in case source font is not found.
Read/write String
.
setDefaultAsianFont
in interface ILoadOptions
public final java.lang.String getPassword()
Gets or sets the password.
Read/write String
.
getPassword
in interface ILoadOptions
public final void setPassword(java.lang.String value)
Gets or sets the password.
Read/write String
.
setPassword
in interface ILoadOptions
public final boolean getOnlyLoadDocumentProperties()
This property makes sense, if presentation file is password protected.
Value of true means that only document properties must be loaded from an encrypted
presentation file and password must be ignored.
Value of false means that entire encrypted presentation must be loaded with use of right
password.
If presentation isn't encrypted then property value is always ignored.
If document properties of an encrypted file aren't public and property value is true then
document properties cannot be loaded and exception will be thrown.
Read/write boolean
.
getOnlyLoadDocumentProperties
in interface ILoadOptions
public final void setOnlyLoadDocumentProperties(boolean value)
This property makes sense, if presentation file is password protected.
Value of true means that only document properties must be loaded from an encrypted
presentation file and password must be ignored.
Value of false means that entire encrypted presentation must be loaded with use of right
password.
If presentation isn't encrypted then property value is always ignored.
If document properties of an encrypted file aren't public and property value is true then
document properties cannot be loaded and exception will be thrown.
Read/write boolean
.
setOnlyLoadDocumentProperties
in interface ILoadOptions
public final IWarningCallback getWarningCallback()
Returns or sets an object which receives warnings and decides whether loading
process will continue or will be aborted.
Read/write IWarningCallback
.
getWarningCallback
in interface ILoadOptions
public final void setWarningCallback(IWarningCallback value)
Returns or sets an object which receives warnings and decides whether loading
process will continue or will be aborted.
Read/write IWarningCallback
.
setWarningCallback
in interface ILoadOptions
public final IBlobManagementOptions getBlobManagementOptions()
Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements.
getBlobManagementOptions
in interface ILoadOptions
public final void setBlobManagementOptions(IBlobManagementOptions value)
Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements.
setBlobManagementOptions
in interface ILoadOptions
public final IFontSources getDocumentLevelFontSources()
Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations
getDocumentLevelFontSources
in interface ILoadOptions
public final void setDocumentLevelFontSources(IFontSources value)
Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations
setDocumentLevelFontSources
in interface ILoadOptions
public final IInterruptionToken getInterruptionToken()
The token to monitor for interruption requests.
IPresentation
instance lifetime. Any long-running operation, such as loading
or saving of presentation, will be interrupted via calling of the InterruptionTokenSource.interrupt()
method of
the InterruptionTokenSource
.
getInterruptionToken
in interface ILoadOptions
public final void setInterruptionToken(IInterruptionToken value)
The token to monitor for interruption requests.
IPresentation
instance lifetime. Any long-running operation, such as loading
or saving of presentation, will be interrupted via calling of the InterruptionTokenSource.interrupt()
method of
the InterruptionTokenSource
.
setInterruptionToken
in interface ILoadOptions
public final IResourceLoadingCallback getResourceLoadingCallback()
Returns or sets callback interface which manages external resources loading.
Read/write IResourceLoadingCallback
.
getResourceLoadingCallback
in interface ILoadOptions
public final void setResourceLoadingCallback(IResourceLoadingCallback value)
Returns or sets callback interface which manages external resources loading.
Read/write IResourceLoadingCallback
.
setResourceLoadingCallback
in interface ILoadOptions