Modifier and Type	Class and Description
protected class	AbstractPushToApplication.PushToApplicationAction

Modifier and Type	Field and Description
protected String	commandPath
protected boolean	couldNotCall
protected boolean	couldNotPush
protected final DialogService	dialogService
private static final Logger	LOGGER
protected boolean	notDefined
protected final PreferencesService	preferencesService

Access	Constructor and Description
public	AbstractPushToApplication(DialogService dialogService, PreferencesService preferencesService)

Method Summary

Modifier and Type	Method and Description
public Action	getAction() Implements org.jabref.gui.push.PushToApplication.getAction.
public JabRefIcon	getApplicationIcon() Implements org.jabref.gui.push.PushToApplication.getApplicationIcon. Gets the icon associated with the application.
protected String	getCitePrefix()
protected String	getCiteSuffix()
protected String[]	Returns: String array with the command to call and its arguments getCommandLine(String String containing the Bibtex keys to be pushed to the application keyString) Constructs the command line arguments for pushing citations to the application.
protected String	Returns: String with the command name getCommandName() Function to get the command name in case it is different from the application name
public String	getDelimiter() Implements org.jabref.gui.push.PushToApplication.getDelimiter.
public PushToApplicationSettings	getSettings(PushToApplication application, PushToApplicationPreferences preferences) Implements org.jabref.gui.push.PushToApplication.getSettings.
public String	getTooltip() Implements org.jabref.gui.push.PushToApplication.getTooltip. Gets a tooltip for the push operation.
public void	onOperationCompleted() Implements org.jabref.gui.push.PushToApplication.onOperationCompleted. Reporting etc., this method is called on the event dispatch thread after pushEntries() returns.
public void	pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString) Implements org.jabref.gui.push.PushToApplication.pushEntries. The actual operation.
protected void	pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString, ProcessBuilder processBuilder)
public boolean	requiresCitationKeys() Implements org.jabref.gui.push.PushToApplication.requiresCitationKeys. Check whether this operation requires citation keys to be set for the entries.

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

Field Detail

commandPath	back to summary
protected String commandPath

couldNotCall	back to summary
protected boolean couldNotCall

couldNotPush	back to summary
protected boolean couldNotPush

dialogService	back to summary
protected final DialogService dialogService

LOGGER	back to summary
private static final Logger LOGGER

notDefined	back to summary
protected boolean notDefined

preferencesService	back to summary
protected final PreferencesService preferencesService

Constructor Detail

AbstractPushToApplication	back to summary
public AbstractPushToApplication(DialogService dialogService, PreferencesService preferencesService)

Method Detail

getAction	back to summary
public Action getAction() Implements org.jabref.gui.push.PushToApplication.getAction. Annotations @Override

getAction

back to summary

public Action getAction()

Implements org.jabref.gui.push.PushToApplication.getAction.

Annotations

@Override

getApplicationIcon	back to summary
public JabRefIcon getApplicationIcon() Implements org.jabref.gui.push.PushToApplication.getApplicationIcon. Doc from org.jabref.gui.push.PushToApplication.getApplicationIcon. Gets the icon associated with the application. Returns:JabRefIcon The icon for the application. Annotations @Override

getApplicationIcon

back to summary

public JabRefIcon getApplicationIcon()

Implements org.jabref.gui.push.PushToApplication.getApplicationIcon.

Doc from org.jabref.gui.push.PushToApplication.getApplicationIcon.

Gets the icon associated with the application.

Returns:JabRefIcon

The icon for the application.

Annotations

@Override

getCitePrefix	back to summary
protected String getCitePrefix()

getCiteSuffix	back to summary
protected String getCiteSuffix()

getCommandLine	back to summary
protected String[] getCommandLine(String keyString) Constructs the command line arguments for pushing citations to the application. The method formats the citation key and prefixes/suffixes as per user preferences before invoking the application with the command to insert text. Parameters keyString:String String containing the Bibtex keys to be pushed to the application Returns:String[] String array with the command to call and its arguments Annotations @SuppressWarnings:unused

getCommandLine

back to summary

protected String[] getCommandLine(String keyString)

Constructs the command line arguments for pushing citations to the application. The method formats the citation key and prefixes/suffixes as per user preferences before invoking the application with the command to insert text.

Parameters

keyString:String: String containing the Bibtex keys to be pushed to the application

Returns:String[]

String array with the command to call and its arguments

Annotations

@SuppressWarnings:unused

getCommandName	back to summary
protected String getCommandName() Function to get the command name in case it is different from the application name Returns:String String with the command name

getCommandName

back to summary

protected String getCommandName()

Function to get the command name in case it is different from the application name

Returns:String: String with the command name

getDelimiter	back to summary
public String getDelimiter() Implements org.jabref.gui.push.PushToApplication.getDelimiter.

getSettings	back to summary
public PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences preferences) Implements org.jabref.gui.push.PushToApplication.getSettings. Annotations @Override

getSettings

back to summary

public PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences preferences)

Implements org.jabref.gui.push.PushToApplication.getSettings.

Annotations

@Override

getTooltip	back to summary
public String getTooltip() Implements org.jabref.gui.push.PushToApplication.getTooltip. Doc from org.jabref.gui.push.PushToApplication.getTooltip. Gets a tooltip for the push operation. Annotations @Override

getTooltip

back to summary

public String getTooltip()

Implements org.jabref.gui.push.PushToApplication.getTooltip.

Doc from org.jabref.gui.push.PushToApplication.getTooltip.

Gets a tooltip for the push operation.

Annotations

@Override

onOperationCompleted	back to summary
public void onOperationCompleted() Implements org.jabref.gui.push.PushToApplication.onOperationCompleted. Doc from org.jabref.gui.push.PushToApplication.onOperationCompleted. Reporting etc., this method is called on the event dispatch thread after pushEntries() returns. Annotations @Override

onOperationCompleted

back to summary

public void onOperationCompleted()

Implements org.jabref.gui.push.PushToApplication.onOperationCompleted.

Doc from org.jabref.gui.push.PushToApplication.onOperationCompleted.

Reporting etc., this method is called on the event dispatch thread after pushEntries() returns.

Annotations

@Override

pushEntries	back to summary
public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString) Implements org.jabref.gui.push.PushToApplication.pushEntries. Doc from org.jabref.gui.push.PushToApplication.pushEntries. The actual operation. This method will not be called on the event dispatch thread, so it should not do GUI operations without utilizing invokeLater(). Annotations @Override

pushEntries

back to summary

public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString)

Implements org.jabref.gui.push.PushToApplication.pushEntries.

Doc from org.jabref.gui.push.PushToApplication.pushEntries.

The actual operation. This method will not be called on the event dispatch thread, so it should not do GUI operations without utilizing invokeLater().

Annotations

@Override

pushEntries	back to summary
protected void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString, ProcessBuilder processBuilder) Annotations @VisibleForTesting

requiresCitationKeys	back to summary
public boolean requiresCitationKeys() Implements org.jabref.gui.push.PushToApplication.requiresCitationKeys. Doc from org.jabref.gui.push.PushToApplication.requiresCitationKeys. Check whether this operation requires citation keys to be set for the entries. If true is returned an error message will be displayed if keys are missing. Returns:boolean true if citation keys are required for this operation. Annotations @Override

requiresCitationKeys

back to summary

public boolean requiresCitationKeys()

Implements org.jabref.gui.push.PushToApplication.requiresCitationKeys.

Doc from org.jabref.gui.push.PushToApplication.requiresCitationKeys.

Check whether this operation requires citation keys to be set for the entries. If true is returned an error message will be displayed if keys are missing.

Returns:boolean

true if citation keys are required for this operation.

Annotations

@Override

org.jabref.gui.push back to summary

protected Class AbstractPushToApplication.PushToApplicationAction

Class Inheritance

extends Object
implements Action

java.lang.Object
org.jabref.gui.push.AbstractPushToApplication.PushToApplicationAction

All Implemented Interfaces

org.jabref.gui.actions.Action

Constructor Summary

Access	Constructor and Description
protected	PushToApplicationAction()

Method Summary

Modifier and Type	Method and Description
public Optional<JabRefIcon>	getIcon() Overrides default org.jabref.gui.actions.Action.getIcon.
public Optional<KeyBinding>	getKeyBinding() Overrides default org.jabref.gui.actions.Action.getKeyBinding.
public String	getText() Implements org.jabref.gui.actions.Action.getText.