public class NotebookLoadOptions extends Object
Options used to load a notebook.
Constructor and Description |
---|
NotebookLoadOptions()
Initializes a new instance of the
NotebookLoadOptions class. |
Modifier and Type | Method and Description |
---|---|
boolean |
getDeferredLoading()
Gets or sets a value indicating whether children documents
should be loaded explicitly later.
|
boolean |
getInstantLoading()
Gets or sets a value indicating whether children documents
should be loaded while the parent document is loading.
|
void |
setDeferredLoading(boolean value)
Gets or sets a value indicating whether children documents
should be loaded explicitly later.
|
void |
setInstantLoading(boolean value)
Gets or sets a value indicating whether children documents
should be loaded while the parent document is loading.
|
public NotebookLoadOptions()
Initializes a new instance of the NotebookLoadOptions
class.
public boolean getInstantLoading()
Gets or sets a value indicating whether children documents should be loaded while the parent document is loading.
false
, so child documents will be loaded "lazily",
i.e. their loading should be postponed until a direct access to specific child.
Value true
is indicating that their loading should be done immediately.
public void setInstantLoading(boolean value)
Gets or sets a value indicating whether children documents should be loaded while the parent document is loading.
false
, so child documents will be loaded "lazily",
i.e. their loading should be postponed until a direct access to specific child.
Value true
is indicating that their loading should be done immediately.
public final boolean getDeferredLoading()
Gets or sets a value indicating whether children documents should be loaded explicitly later.
false
, so child documents will be loaded implicitly.
Value true
is indicating that user should call Notebook.loadChildDocument
or
for each notebook's child node after notebook itself is loaded.
If value is true
, NotebookLoadOptions.instantLoading
option will be ignored.
If notebook is loading from stream, the value is always true
despite was explicitly set by user to false
.
public final void setDeferredLoading(boolean value)
Gets or sets a value indicating whether children documents should be loaded explicitly later.
false
, so child documents will be loaded implicitly.
Value true
is indicating that user should call Notebook.loadChildDocument
or
for each notebook's child node after notebook itself is loaded.
If value is true
, NotebookLoadOptions.instantLoading
option will be ignored.
If notebook is loading from stream, the value is always true
despite was explicitly set by user to false
.