JabRef 6.0-beta.1 · org.jabref.gui.openoffice.OOBibBase

Modifier and Type	Field and Description
private final BibEntryTypesManager	bibEntryTypesManager
private BSTCitationOOAdapter	bstCitationOOAdapter
private BstUpdateBibliography	bstUpdateBibliography
private final com.sun.star.uno.XComponentContext	componentContext
private final OOBibBaseConnect	connection
private CSLCitationOOAdapter	cslCitationOOAdapter
private CSLUpdateBibliography	cslUpdateBibliography
private final DialogService	dialogService
private static final Logger	LOGGER
private final OpenOfficePreferences	openOfficePreferences

Access	Constructor and Description
public	OOBibBase(Path loPath, DialogService dialogService, OpenOfficePreferences openOfficePreferences, BibEntryTypesManager bibEntryTypesManager)

Method Summary

Modifier and Type	Method and Description
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	checkCitationMarkersOutsidePendingDeletions(com.sun.star.text.XTextDocument doc, OOStyle style, OOFrontend frontend)
private static org.jabref.model.openoffice.util.OOVoidResult<OOError>	checkRangeOverlaps(com.sun.star.text.XTextDocument doc, OOFrontend frontend)
private static org.jabref.model.openoffice.util.OOVoidResult<OOError>	checkRangeOverlapsWithCursor(com.sun.star.text.XTextDocument doc, OOFrontend frontend, OOStyle style)
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	checkStyleExistsInTheDocument(String familyName, String styleName, com.sun.star.text.XTextDocument doc, String labelInJstyleFile, String pathToStyleFile)
public org.jabref.model.openoffice.util.OOVoidResult<OOError>	checkStylesExistInTheDocument(JStyle jStyle, com.sun.star.text.XTextDocument doc)
private void	clearCitationAdapters() Clear all document-bound helpers after connection loss or before switching to another document.
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError>	collectResults(String errorTitle, List<org.jabref.model.openoffice.util.OOVoidResult<OOError>> results)
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError>	databaseIsRequired(List<BibDatabase> databases, Supplier<OOError> fun)
public void	dispose() `dispose` in SE is usually treated as a lifecycle hook which means that the concerned object is no longer to be used.
private org.jabref.model.openoffice.util.OOResult<GenerateDatabaseResult, JabRefException>	exportCitedForBST(List<BibDatabase> databases)
private org.jabref.model.openoffice.util.OOResult<GenerateDatabaseResult, JabRefException>	exportCitedForCSL(List<BibDatabase> databases)
public Optional<BibDatabase>	exportCitedHelper(List<BibDatabase> databases, OOStyle style, boolean If there are some unresolved keys, shall we return an otherwise nonempty result, or Optional.empty()? returnPartialResult) GUI action for "Export cited" Does not refresh the bibliography.
public Optional<String>	getCurrentDocumentTitle() The title of the current document, or Optional.empty()
pack-priv org.jabref.model.openoffice.util.OOResult<OOFrontend, OOError>	getFrontend(com.sun.star.text.XTextDocument doc)
pack-priv org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError>	getFunctionalTextViewCursor(com.sun.star.text.XTextDocument doc, String errorTitle) This may move the view cursor.
pack-priv org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError>	getUserCursorForTextInsertion(com.sun.star.text.XTextDocument doc, String errorTitle) Get the cursor positioned by the user for inserting text.
public org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextDocument, OOError>	getXTextDocument() Either return an XTextDocument or return JabRefException.
public void	guiActionApplyCitationEntries(List<CitationEntry> citationEntries) Apply editable parts of citationEntries to the document: store pageInfo.
public Optional<List<CitationEntry>>	guiActionGetCitationEntries()
public void	guiActionInsertEntry(List<BibEntry> The entries to cite. entries, BibDatabaseContext The database the entries belong to (all of them). Used when creating the citation mark. bibDatabaseContext, List<BibDatabase> The databases selected for citation lookup in this action. selectedDatabases, OOStyle The bibliography style we are using. style, CitationType Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation. citationType, String A single page-info for these entries. Attributed to the last entry. pageInfo, Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list. syncOptions) Creates a citation group from `entries` at the cursor.
public void	guiActionMergeCitationGroups(List<BibDatabase> databases, OOStyle style) GUI action "Merge citations"
public void	guiActionSelectDocument(boolean autoSelectForSingle)
public void	guiActionSeparateCitations(List<BibDatabase> databases, OOStyle style) GUI action "Separate citations".
public void	guiActionUpdateDocument(List<BibDatabase> Must have at least one. databases, OOStyle Style. style) GUI action, refreshes citation markers and bibliography.
pack-priv org.jabref.model.openoffice.util.OOResult<Optional<CitationStyle>, OOError>	inferCslStyleFromDocument()
private org.jabref.model.openoffice.util.OOResult<Optional<CitationStyle>, OOError>	inferCslStyleFromDocument(com.sun.star.text.XTextDocument doc)
private void	initializeCitationAdapter(com.sun.star.text.XTextDocument doc) Adapter lifecycle is tied to the currently selected document.
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	insertBstCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, BstStyle bstStyle, BibDatabaseContext bibDatabaseContext, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor) Helper method for guiActionInsertEntry - handles BST citation insertion.
public org.jabref.model.openoffice.util.OOVoidResult<OOError>	insertCSLCitation(List<BibEntry> The entries to cite. entries, com.sun.star.text.XTextDocument doc, CitationType Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation. citationType, CitationStyle Indicates style, name and path of citation citationStyle, BibDatabaseContext The database the entries belong to. Used when creating the citation mark. currentEntryContext, List<BibDatabase> The databases selected for resolving existing CSL citations during this action. selectedDatabases, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list. syncOptions) Helper method for guiActionInsertEntry.
public org.jabref.model.openoffice.util.OOVoidResult<OOError>	insertJStyleCitation(List<BibEntry> The entries to cite. entries, com.sun.star.text.XTextDocument doc, CitationType Indicates whether it is an in-text citation, a citation in parentheses or an invisible citation. citationType, JStyle Indicates citation formating in JStyle jStyle, org.jabref.model.openoffice.util.OOResult<OOFrontend, OOError> frontend, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, BibDatabaseContext The database the entries belong to (all of them). Used when creating the citation mark. bibDatabaseContext, Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list. syncOptions, String A single page-info for these entries. Attributed to the last entry. pageInfo, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor) Helper method for guiActionInsertEntry Throws PropertyVetoException, WrappedTargetException, IllegalTypeException, NotRemoveableException, CreationException, NoDocumentException Exceptions caught by guiActionInsertEntry
public boolean	isConnectedToDocument() A simple test for document availability.
public boolean	isDocumentConnectionMissing() Returns: true if we are connected to a document
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError>	selectedBibEntryIsRequired(List<BibEntry> entries, Supplier<OOError> fun)
pack-priv void	showDialog(OOError err)
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError>	styleIsRequired(OOStyle style)
private <T> T	supplyWithTrackChangesSuspended(com.sun.star.text.XTextDocument doc, Supplier<T> action) Run a marker-rewriting action with change recording suspended.
pack-priv boolean	testDialog(org.jabref.model.openoffice.util.OOVoidResult<OOError> res)
pack-priv boolean	testDialog(String errorTitle, org.jabref.model.openoffice.util.OOVoidResult<OOError> res)
pack-priv final boolean	testDialog(String errorTitle, org.jabref.model.openoffice.util.OOVoidResult<OOError>... results)
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	updateBstBibliography(List<BibDatabase> Must have at least one. databases, BstStyle BST style to update the bibliography with. bstStyle, com.sun.star.text.XTextDocument Text document. doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> Used to synchronize document. fcursor, String Error message for user. errorTitle) Helper method for guiActionUpdateDocument - refreshes a BST bibliography.
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	updateCSLBibliography(List<BibDatabase> Must have at least one. databases, CitationStyle Citation style to update bibliography with. citationStyle, com.sun.star.text.XTextDocument Text document. doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> Used to synchronize document. fcursor, String Error message for user. errorTitle) Helper method for guiActionUpdateDocument, refreshes a CSL bibliography.
pack-priv static org.jabref.model.openoffice.util.OOVoidResult<OOError>	updateCSLBibliography(DialogService dialogService, List<BibDatabase> databases, CitationStyle citationStyle, com.sun.star.text.XTextDocument doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String errorTitle, CSLCitationOOAdapter cslCitationOOAdapter, CSLUpdateBibliography cslUpdateBibliography)
private org.jabref.model.openoffice.util.OOVoidResult<OOError>	updateJStyleBibliography(List<BibDatabase> Must have at least one. databases, JStyle Indicates citation formating in JStyle. jStyle, com.sun.star.text.XTextDocument Text document. doc, OOFrontend frontend, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String Error message for user. errorTitle) Helper method for guiActionUpdateDocument, refreshes a JStyle bibliography.
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError>	writeDocumentCslStyle(CitationStyle citationStyle)
pack-priv static org.jabref.model.openoffice.util.OOVoidResult<OOError>	writeDocumentCslStyle(com.sun.star.text.XTextDocument doc, CitationStyle citationStyle)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bibEntryTypesManager	back to summary
private final BibEntryTypesManager bibEntryTypesManager

bstCitationOOAdapter	back to summary
private BSTCitationOOAdapter bstCitationOOAdapter

bstUpdateBibliography	back to summary
private BstUpdateBibliography bstUpdateBibliography

componentContext	back to summary
private final com.sun.star.uno.XComponentContext componentContext

connection	back to summary
private final OOBibBaseConnect connection

cslCitationOOAdapter	back to summary
private CSLCitationOOAdapter cslCitationOOAdapter

cslUpdateBibliography	back to summary
private CSLUpdateBibliography cslUpdateBibliography

dialogService	back to summary
private final DialogService dialogService

LOGGER	back to summary
private static final Logger LOGGER

openOfficePreferences	back to summary
private final OpenOfficePreferences openOfficePreferences

OOBibBase	back to summary
public OOBibBase(Path loPath, DialogService dialogService, OpenOfficePreferences openOfficePreferences, BibEntryTypesManager bibEntryTypesManager) throws BootstrapException, org.jabref.model.openoffice.uno.CreationException, IOException, InterruptedException

Method Detail

checkCitationMarkersOutsidePendingDeletions	back to summary
private org.jabref.model.openoffice.util.OOVoidResult<OOError> checkCitationMarkersOutsidePendingDeletions(com.sun.star.text.XTextDocument doc, OOStyle style, OOFrontend frontend)

checkRangeOverlaps	back to summary
private static org.jabref.model.openoffice.util.OOVoidResult<OOError> checkRangeOverlaps(com.sun.star.text.XTextDocument doc, OOFrontend frontend)

checkRangeOverlapsWithCursor	back to summary
private static org.jabref.model.openoffice.util.OOVoidResult<OOError> checkRangeOverlapsWithCursor(com.sun.star.text.XTextDocument doc, OOFrontend frontend, OOStyle style)

checkStyleExistsInTheDocument	back to summary
private org.jabref.model.openoffice.util.OOVoidResult<OOError> checkStyleExistsInTheDocument(String familyName, String styleName, com.sun.star.text.XTextDocument doc, String labelInJstyleFile, String pathToStyleFile) throws com.sun.star.lang.WrappedTargetException

checkStylesExistInTheDocument	back to summary
public org.jabref.model.openoffice.util.OOVoidResult<OOError> checkStylesExistInTheDocument(JStyle jStyle, com.sun.star.text.XTextDocument doc)

clearCitationAdapters	back to summary
private void clearCitationAdapters() Clear all document-bound helpers after connection loss or before switching to another document.

collectResults	back to summary
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError> collectResults(String errorTitle, List<org.jabref.model.openoffice.util.OOVoidResult<OOError>> results)

databaseIsRequired	back to summary
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError> databaseIsRequired(List<BibDatabase> databases, Supplier<OOError> fun)

dispose back to summary

dispose	back to summary
public void dispose() `dispose` in SE is usually treated as a lifecycle hook which means that the concerned object is no longer to be used. It is arguable that this wrapper logically adds no extra functionality over `clearCitationAdapters` (the private helper), but it is to maintain a semantic split when called from `OpenOfficePanel` externally - meaning clear related resources without knowing "what". When called internally, we use the private helper as it does not come with the meaning mentioned above, as we are about to reuse the same `ooBase` object.

public void dispose()

dispose in SE is usually treated as a lifecycle hook which means that the concerned object is no longer to be used.

It is arguable that this wrapper logically adds no extra functionality over clearCitationAdapters (the private helper), but it is to maintain a semantic split when called from OpenOfficePanel externally - meaning clear related resources without knowing "what".

When called internally, we use the private helper as it does not come with the meaning mentioned above, as we are about to reuse the same ooBase object.

exportCitedForBST	back to summary
private org.jabref.model.openoffice.util.OOResult<GenerateDatabaseResult, JabRefException> exportCitedForBST(List<BibDatabase> databases)

exportCitedForCSL	back to summary
private org.jabref.model.openoffice.util.OOResult<GenerateDatabaseResult, JabRefException> exportCitedForCSL(List<BibDatabase> databases)

exportCitedHelper	back to summary
public Optional<BibDatabase> exportCitedHelper(List<BibDatabase> databases, OOStyle style, boolean returnPartialResult) GUI action for "Export cited" Does not refresh the bibliography. Parameters returnPartialResult:boolean If there are some unresolved keys, shall we return an otherwise nonempty result, or Optional.empty()?

exportCitedHelper

back to summary

public Optional<BibDatabase> exportCitedHelper(List<BibDatabase> databases, OOStyle style, boolean returnPartialResult)

GUI action for "Export cited"

Does not refresh the bibliography.

Parameters

returnPartialResult:boolean: If there are some unresolved keys, shall we return an otherwise nonempty result, or Optional.empty()?

getCurrentDocumentTitle	back to summary
public Optional<String> getCurrentDocumentTitle() The title of the current document, or Optional.empty()

getFrontend	back to summary
pack-priv org.jabref.model.openoffice.util.OOResult<OOFrontend, OOError> getFrontend(com.sun.star.text.XTextDocument doc)

getFunctionalTextViewCursor	back to summary
pack-priv org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> getFunctionalTextViewCursor(com.sun.star.text.XTextDocument doc, String errorTitle) This may move the view cursor.

getUserCursorForTextInsertion	back to summary
pack-priv org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> getUserCursorForTextInsertion(com.sun.star.text.XTextDocument doc, String errorTitle) Get the cursor positioned by the user for inserting text.

getXTextDocument	back to summary
public org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextDocument, OOError> getXTextDocument() Either return an XTextDocument or return JabRefException.

guiActionApplyCitationEntries	back to summary
public void guiActionApplyCitationEntries(List<CitationEntry> citationEntries) Apply editable parts of citationEntries to the document: store pageInfo. Does not change presentation. Note we use no undo context here, because only DocumentConnection.setUserDefinedStringPropertyValue() is called, and Undo in LO will not undo that. GUI: "Manage citations" dialog "OK" button. Called from: ManageCitationsDialogViewModel.storeSettings Currently the only editable part is pageInfo. Since the only call to applyCitationEntries() only changes pageInfo w.r.t those returned by getCitationEntries(), we can do with the following restrictions: Missing pageInfo means no action. Missing CitationEntry means no action (no attempt to remove citation from the text).

guiActionApplyCitationEntries

back to summary

public void guiActionApplyCitationEntries(List<CitationEntry> citationEntries)

Apply editable parts of citationEntries to the document: store pageInfo.

Does not change presentation.

Note

we use no undo context here, because only DocumentConnection.setUserDefinedStringPropertyValue() is called, and Undo in LO will not undo that.

GUI: "Manage citations" dialog "OK" button. Called from: ManageCitationsDialogViewModel.storeSettings

Currently the only editable part is pageInfo.

Since the only call to applyCitationEntries() only changes pageInfo w.r.t those returned by getCitationEntries(), we can do with the following restrictions:

Missing pageInfo means no action.
Missing CitationEntry means no action (no attempt to remove citation from the text).

guiActionGetCitationEntries	back to summary
public Optional<List<CitationEntry>> guiActionGetCitationEntries()

guiActionInsertEntry back to summary

guiActionInsertEntry	back to summary
public void guiActionInsertEntry(List<BibEntry> entries, BibDatabaseContext bibDatabaseContext, List<BibDatabase> selectedDatabases, OOStyle style, CitationType citationType, String pageInfo, Optional<SyncOptions> syncOptions) Creates a citation group from `entries` at the cursor. Uses LO undo context "Insert citation". Note Undo does not remove or reestablish custom properties. Consistency: for each entry in `entries`: looking it up in `syncOptions.get().databases` (if present) should yield `database`. Parameters entries:List<BibEntry> The entries to cite. bibDatabaseContext:BibDatabaseContext The database the entries belong to (all of them). Used when creating the citation mark. selectedDatabases:List<BibDatabase> The databases selected for citation lookup in this action. style:OOStyle The bibliography style we are using. citationType:CitationType Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation. pageInfo:String A single page-info for these entries. Attributed to the last entry. syncOptions:Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.

public void guiActionInsertEntry(List<BibEntry> entries, BibDatabaseContext bibDatabaseContext, List<BibDatabase> selectedDatabases, OOStyle style, CitationType citationType, String pageInfo, Optional<SyncOptions> syncOptions)

Creates a citation group from entries at the cursor.

Uses LO undo context "Insert citation".

Note

Undo does not remove or reestablish custom properties.

Consistency: for each entry in entries: looking it up in syncOptions.get().databases (if present) should yield database.

Parameters

entries:List<BibEntry>: The entries to cite.
bibDatabaseContext:BibDatabaseContext: The database the entries belong to (all of them). Used when creating the citation mark.
selectedDatabases:List<BibDatabase>: The databases selected for citation lookup in this action.
style:OOStyle: The bibliography style we are using.
citationType:CitationType: Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation.
pageInfo:String: A single page-info for these entries. Attributed to the last entry.
syncOptions:Optional<SyncOptions>: Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.

guiActionMergeCitationGroups	back to summary
public void guiActionMergeCitationGroups(List<BibDatabase> databases, OOStyle style) GUI action "Merge citations"

guiActionSelectDocument	back to summary
public void guiActionSelectDocument(boolean autoSelectForSingle) throws com.sun.star.lang.WrappedTargetException, com.sun.star.container.NoSuchElementException

guiActionSeparateCitations	back to summary
public void guiActionSeparateCitations(List<BibDatabase> databases, OOStyle style) GUI action "Separate citations". Do the opposite of MergeCitationGroups. Combined markers are split, with a space inserted between.

guiActionSeparateCitations

back to summary

public void guiActionSeparateCitations(List<BibDatabase> databases, OOStyle style)

GUI action "Separate citations".

Do the opposite of MergeCitationGroups. Combined markers are split, with a space inserted between.

guiActionUpdateDocument	back to summary
public void guiActionUpdateDocument(List<BibDatabase> databases, OOStyle style) GUI action, refreshes citation markers and bibliography. Parameters databases:List<BibDatabase> Must have at least one. style:OOStyle Style.

guiActionUpdateDocument

back to summary

public void guiActionUpdateDocument(List<BibDatabase> databases, OOStyle style)

GUI action, refreshes citation markers and bibliography.

Parameters

databases:List<BibDatabase>: Must have at least one.
style:OOStyle: Style.

inferCslStyleFromDocument	back to summary
pack-priv org.jabref.model.openoffice.util.OOResult<Optional<CitationStyle>, OOError> inferCslStyleFromDocument()

inferCslStyleFromDocument	back to summary
private org.jabref.model.openoffice.util.OOResult<Optional<CitationStyle>, OOError> inferCslStyleFromDocument(com.sun.star.text.XTextDocument doc)

initializeCitationAdapter	back to summary
private void initializeCitationAdapter(com.sun.star.text.XTextDocument doc) throws com.sun.star.lang.WrappedTargetException, com.sun.star.container.NoSuchElementException Adapter lifecycle is tied to the currently selected document. Keep creation here so cite/export/ bibliography actions only ever use adapters that were initialized as part of document selection.

insertBstCitation	back to summary
private org.jabref.model.openoffice.util.OOVoidResult<OOError> insertBstCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, BstStyle bstStyle, BibDatabaseContext bibDatabaseContext, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor) Helper method for guiActionInsertEntry - handles BST citation insertion.

insertCSLCitation	back to summary
public org.jabref.model.openoffice.util.OOVoidResult<OOError> insertCSLCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, CitationType citationType, CitationStyle citationStyle, BibDatabaseContext currentEntryContext, List<BibDatabase> selectedDatabases, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, Optional<SyncOptions> syncOptions) Helper method for guiActionInsertEntry. Handles CSL citation insertion Throws CreationException, com.sun.star.uno.Exception Caught by guiActionInsertEntry Parameters entries:List<BibEntry> The entries to cite. citationType:CitationType Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation. citationStyle:CitationStyle Indicates style, name and path of citation currentEntryContext:BibDatabaseContext The database the entries belong to. Used when creating the citation mark. selectedDatabases:List<BibDatabase> The databases selected for resolving existing CSL citations during this action. syncOptions:Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.

insertCSLCitation

back to summary

public org.jabref.model.openoffice.util.OOVoidResult<OOError> insertCSLCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, CitationType citationType, CitationStyle citationStyle, BibDatabaseContext currentEntryContext, List<BibDatabase> selectedDatabases, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, Optional<SyncOptions> syncOptions)

Helper method for guiActionInsertEntry. Handles CSL citation insertion Throws CreationException, com.sun.star.uno.Exception Caught by guiActionInsertEntry

Parameters

entries:List<BibEntry>: The entries to cite.
citationType:CitationType: Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation.
citationStyle:CitationStyle: Indicates style, name and path of citation
currentEntryContext:BibDatabaseContext: The database the entries belong to. Used when creating the citation mark.
selectedDatabases:List<BibDatabase>: The databases selected for resolving existing CSL citations during this action.
syncOptions:Optional<SyncOptions>: Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.

insertJStyleCitation	back to summary
public org.jabref.model.openoffice.util.OOVoidResult<OOError> insertJStyleCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, CitationType citationType, JStyle jStyle, org.jabref.model.openoffice.util.OOResult<OOFrontend, OOError> frontend, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, BibDatabaseContext bibDatabaseContext, Optional<SyncOptions> syncOptions, String pageInfo, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor) Helper method for guiActionInsertEntry Throws PropertyVetoException, WrappedTargetException, IllegalTypeException, NotRemoveableException, CreationException, NoDocumentException Exceptions caught by guiActionInsertEntry Parameters entries:List<BibEntry> The entries to cite. citationType:CitationType Indicates whether it is an in-text citation, a citation in parentheses or an invisible citation. jStyle:JStyle Indicates citation formating in JStyle bibDatabaseContext:BibDatabaseContext The database the entries belong to (all of them). Used when creating the citation mark. syncOptions:Optional<SyncOptions> Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list. pageInfo:String A single page-info for these entries. Attributed to the last entry.

insertJStyleCitation

back to summary

public org.jabref.model.openoffice.util.OOVoidResult<OOError> insertJStyleCitation(List<BibEntry> entries, com.sun.star.text.XTextDocument doc, CitationType citationType, JStyle jStyle, org.jabref.model.openoffice.util.OOResult<OOFrontend, OOError> frontend, org.jabref.model.openoffice.util.OOResult<com.sun.star.text.XTextCursor, OOError> cursor, BibDatabaseContext bibDatabaseContext, Optional<SyncOptions> syncOptions, String pageInfo, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor)

Helper method for guiActionInsertEntry Throws PropertyVetoException, WrappedTargetException, IllegalTypeException, NotRemoveableException, CreationException, NoDocumentException Exceptions caught by guiActionInsertEntry

Parameters

entries:List<BibEntry>: The entries to cite.
citationType:CitationType: Indicates whether it is an in-text citation, a citation in parentheses or an invisible citation.
jStyle:JStyle: Indicates citation formating in JStyle
bibDatabaseContext:BibDatabaseContext: The database the entries belong to (all of them). Used when creating the citation mark.
syncOptions:Optional<SyncOptions>: Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.
pageInfo:String: A single page-info for these entries. Attributed to the last entry.

isConnectedToDocument back to summary

isConnectedToDocument	back to summary
public boolean isConnectedToDocument() A simple test for document availability. See also `isDocumentConnectionMissing` for a test actually attempting to use the connection.

public boolean isConnectedToDocument()

A simple test for document availability.

See also isDocumentConnectionMissing for a test actually attempting to use the connection.

isDocumentConnectionMissing	back to summary
public boolean isDocumentConnectionMissing() Returns:boolean true if we are connected to a document

selectedBibEntryIsRequired	back to summary
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError> selectedBibEntryIsRequired(List<BibEntry> entries, Supplier<OOError> fun)

showDialog	back to summary
pack-priv void showDialog(OOError err)

styleIsRequired	back to summary
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError> styleIsRequired(OOStyle style)

supplyWithTrackChangesSuspended	back to summary
private <T> T supplyWithTrackChangesSuspended(com.sun.star.text.XTextDocument doc, Supplier<T> action) Run a marker-rewriting action with change recording suspended. This prevents duplicated citations when Writer's change recording is enabled: deleting the old marker would otherwise only mark it as deleted, leaving old and new marker side by side.

supplyWithTrackChangesSuspended

back to summary

private <T> T supplyWithTrackChangesSuspended(com.sun.star.text.XTextDocument doc, Supplier<T> action)

Run a marker-rewriting action with change recording suspended.

This prevents duplicated citations when Writer's change recording is enabled: deleting the old marker would otherwise only mark it as deleted, leaving old and new marker side by side.

testDialog	back to summary
pack-priv boolean testDialog(org.jabref.model.openoffice.util.OOVoidResult<OOError> res)

testDialog	back to summary
pack-priv boolean testDialog(String errorTitle, org.jabref.model.openoffice.util.OOVoidResult<OOError> res)

testDialog	back to summary
pack-priv final boolean testDialog(String errorTitle, org.jabref.model.openoffice.util.OOVoidResult<OOError>... results) Annotations @SafeVarargs

updateBstBibliography

back to summary

private org.jabref.model.openoffice.util.OOVoidResult<OOError> updateBstBibliography(List<BibDatabase> databases, BstStyle bstStyle, com.sun.star.text.XTextDocument doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String errorTitle)

Helper method for guiActionUpdateDocument - refreshes a BST bibliography.

Parameters

databases:List<BibDatabase>: Must have at least one.
bstStyle:BstStyle: BST style to update the bibliography with.
doc:com.sun.star.text.XTextDocument: Text document.
fcursor:org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError>: Used to synchronize document.
errorTitle:String: Error message for user.

updateCSLBibliography

back to summary

private org.jabref.model.openoffice.util.OOVoidResult<OOError> updateCSLBibliography(List<BibDatabase> databases, CitationStyle citationStyle, com.sun.star.text.XTextDocument doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String errorTitle)

Helper method for guiActionUpdateDocument, refreshes a CSL bibliography.

Parameters

databases:List<BibDatabase>: Must have at least one.
citationStyle:CitationStyle: Citation style to update bibliography with.
doc:com.sun.star.text.XTextDocument: Text document.
fcursor:org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError>: Used to synchronize document.
errorTitle:String: Error message for user.

updateCSLBibliography

back to summary

pack-priv static org.jabref.model.openoffice.util.OOVoidResult<OOError> updateCSLBibliography(DialogService dialogService, List<BibDatabase> databases, CitationStyle citationStyle, com.sun.star.text.XTextDocument doc, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String errorTitle, CSLCitationOOAdapter cslCitationOOAdapter, CSLUpdateBibliography cslUpdateBibliography)

updateJStyleBibliography

back to summary

private org.jabref.model.openoffice.util.OOVoidResult<OOError> updateJStyleBibliography(List<BibDatabase> databases, JStyle jStyle, com.sun.star.text.XTextDocument doc, OOFrontend frontend, org.jabref.model.openoffice.util.OOResult<FunctionalTextViewCursor, OOError> fcursor, String errorTitle)

Helper method for guiActionUpdateDocument, refreshes a JStyle bibliography.

Parameters

databases:List<BibDatabase>: Must have at least one.
jStyle:JStyle: Indicates citation formating in JStyle.
doc:com.sun.star.text.XTextDocument: Text document.
errorTitle:String: Error message for user.

writeDocumentCslStyle	back to summary
pack-priv org.jabref.model.openoffice.util.OOVoidResult<OOError> writeDocumentCslStyle(CitationStyle citationStyle)

writeDocumentCslStyle	back to summary
pack-priv static org.jabref.model.openoffice.util.OOVoidResult<OOError> writeDocumentCslStyle(com.sun.star.text.XTextDocument doc, CitationStyle citationStyle)

public Class OOBibBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail