Verified Owner
Top Fields Constructors Methods
org.jabref.gui.util.component

public Class HelpButton

extends Button
Class Inheritance
Imports
javafx.beans.property.SimpleStringProperty, .StringProperty, javafx.scene.control.Button, org.jabref.gui.DialogService, org.jabref.gui.edit.OpenBrowserAction, org.jabref.gui.frame.ExternalApplicationsPreferences, org.jabref.gui.help.HelpAction, org.jabref.gui.icon.IconTheme, org.jabref.gui.preferences.GuiPreferences, org.jabref.gui.util.BindingsHelper, org.jabref.logic.help.HelpFile, com.airhacks.afterburner.injection.Injector, org.jspecify.annotations.NonNull

Field Summary

Modifier and TypeField and Description
private final StringProperty
helpUrl

private boolean
isHelpFileSet

Constructor Summary

AccessConstructor and Description
public
HelpButton()

public
HelpButton(@NonNull String url)

Method Summary

Modifier and TypeMethod and Description
public String
getHelpUrl()

This method is not used by JabRef, but provided for FXML usage.

public StringProperty
helpUrlProperty()

This method is not used by JabRef, but provided for FXML usage.

public void
setHelpFile(@NonNull HelpFile helpFile, @NonNull DialogService dialogService, @NonNull ExternalApplicationsPreferences externalApplicationsPreferences)

public void
setHelpUrl(@NonNull String helpUrl)

This method is used both internally in JabRef's code base, but also for FXML usage.

Inherited from javafx.scene.control.Button:
cancelButtonPropertycreateDefaultSkindefaultButtonPropertyfireisCancelButtonisDefaultButtonsetCancelButtonsetDefaultButton

Field Detail

helpUrlback to summary
private final StringProperty helpUrl
isHelpFileSetback to summary
private boolean isHelpFileSet

Constructor Detail

HelpButtonback to summary
public HelpButton()
HelpButtonback to summary
public HelpButton(@NonNull String url)

Method Detail

getHelpUrlback to summary
public String getHelpUrl()

This method is not used by JabRef, but provided for FXML usage.

helpUrlPropertyback to summary
public StringProperty helpUrlProperty()

This method is not used by JabRef, but provided for FXML usage.

setHelpFileback to summary
public void setHelpFile(@NonNull HelpFile helpFile, @NonNull DialogService dialogService, @NonNull ExternalApplicationsPreferences externalApplicationsPreferences)
setHelpUrlback to summary
public void setHelpUrl(@NonNull String helpUrl)

This method is used both internally in JabRef's code base, but also for FXML usage. Do not refactor this.