Top Description Methods
org.jabref.gui.push

public Interface PushToApplication

Known Direct Implementers
org.jabref.gui.push.AbstractPushToApplication
Imports
java.nio.file.Path, java.util.List, org.jabref.gui.actions.Action, org.jabref.gui.icon.JabRefIcon, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry
Class that defines interaction with an external application in the form of "pushing" selected entries to it.

Method Summary

Modifier and TypeMethod and Description
public Action
getAction()

public JabRefIcon

Returns:

The icon for the application.
getApplicationIcon()

Gets the icon associated with the application.

public String
getDelimiter()

public String

Returns:

The display name for the push operation.
getDisplayName()

Gets the display name for the push operation.

public PushToApplicationSettings
getSettings(PushToApplication application, PushToApplicationPreferences pushToApplicationPreferences)

public String
getTooltip()

Gets a tooltip for the push operation.

public void
jumpToLine(Path fileName, int line, int column)

public void
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)

The actual operation.

public boolean

Returns:

true if citation keys are required for this operation.
requiresCitationKeys()

Check whether this operation requires citation keys to be set for the entries.

Method Detail

getActionback to summary
public Action getAction()
getApplicationIconback to summary
public JabRefIcon getApplicationIcon()

Gets the icon associated with the application.

Returns:JabRefIcon

The icon for the application.

getDelimiterback to summary
public String getDelimiter()
getDisplayNameback to summary
public String getDisplayName()

Gets the display name for the push operation. This name is used in the GUI to represent the push action to the user.

Returns:String

The display name for the push operation.

getSettingsback to summary
public PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences pushToApplicationPreferences)
getTooltipback to summary
public String getTooltip()

Gets a tooltip for the push operation.

jumpToLineback to summary
public void jumpToLine(Path fileName, int line, int column)
onOperationCompletedback to summary
public void onOperationCompleted()

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

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

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

requiresCitationKeysback to summary
public boolean 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.