NotebookSaveOptions
Inheritance: java.lang.Object
public abstract class NotebookSaveOptions
An abstract base class which represents notebook saving options for a particular format.
Methods
| Method | Description |
|---|---|
| getSaveFormat() | Gets the format in which the notebook is saved. |
| getFlatten() | Gets or sets a value indicating whether the notebook children hierarchy is saved flattened. |
| setFlatten(boolean value) | Gets or sets a value indicating whether the notebook children hierarchy is saved flattened. |
| getDeferredSaving() | Gets or sets a value indicating whether children documents should be saved explicitly. |
| setDeferredSaving(boolean value) | Gets or sets a value indicating whether children documents should be saved explicitly. |
| getDocumentSaveOptionsInternal() | Gets the save options for all notebook’s child documents. |
getSaveFormat()
public abstract int getSaveFormat()
Gets the format in which the notebook is saved.
Returns: int
getFlatten()
public boolean getFlatten()
Gets or sets a value indicating whether the notebook children hierarchy is saved flattened.
Returns: boolean
setFlatten(boolean value)
public void setFlatten(boolean value)
Gets or sets a value indicating whether the notebook children hierarchy is saved flattened.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDeferredSaving()
public boolean getDeferredSaving()
Gets or sets a value indicating whether children documents should be saved explicitly.
Default value is false , so child documents will be saved implicitly. Value true is indicating that user should save each notebook’s child node explicitly. If notebook is saving to stream, the value is always true despite was explicitly set by user to false .
Returns: boolean
setDeferredSaving(boolean value)
public void setDeferredSaving(boolean value)
Gets or sets a value indicating whether children documents should be saved explicitly.
Default value is false , so child documents will be saved implicitly. Value true is indicating that user should save each notebook’s child node explicitly. If notebook is saving to stream, the value is always true despite was explicitly set by user to false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDocumentSaveOptionsInternal()
public abstract SaveOptions getDocumentSaveOptionsInternal()
Gets the save options for all notebook’s child documents.
Returns: SaveOptions - The SaveOptions .