Package org.gnome.adw

Class AboutDialog.Builder<B extends AboutDialog.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gobject.InitiallyUnowned.Builder<B>

org.gnome.gtk.Widget.Builder<B>

org.gnome.adw.Dialog.Builder<B>

org.gnome.adw.AboutDialog.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface, Accessible.Builder<B>

Enclosing class:

AboutDialog

public static class AboutDialog.Builder<B extends AboutDialog.Builder<B>>
extends Dialog.Builder<B>
implements Accessible.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
AboutDialog	build()	Finish building the AboutDialog object.
B	onActivateLink(AboutDialog.ActivateLinkCallback handler)	Emitted when a URL is activated.
B	setApplicationIcon(String applicationIcon)	The name of the application icon.
B	setApplicationName(String applicationName)	The name of the application.
B	setArtists(String[] artists)	The list of artists of the application.
B	setComments(String comments)	The comments about the application.
B	setCopyright(String copyright)	The copyright information.
B	setDebugInfo(String debugInfo)	The debug information.
B	setDebugInfoFilename(String debugInfoFilename)	The debug information filename.
B	setDesigners(String[] designers)	The list of designers of the application.
B	setDeveloperName(String developerName)	The developer name.
B	setDevelopers(String[] developers)	The list of developers of the application.
B	setDocumenters(String[] documenters)	The list of documenters of the application.
B	setIssueUrl(String issueUrl)	The URL for the application's issue tracker.
B	setLicense(String license)	The license text.
B	setLicenseType(License licenseType)	The license type.
B	setReleaseNotes(String releaseNotes)	The release notes of the application.
B	setReleaseNotesVersion(String releaseNotesVersion)	The version described by the application's release notes.
B	setSupportUrl(String supportUrl)	The URL of the application's support page.
B	setTranslatorCredits(String translatorCredits)	The translator credits string.
B	setVersion(String version)	The version of the application.
B	setWebsite(String website)	The URL of the application's website.

Methods inherited from class org.gnome.adw.Dialog.Builder

onCloseAttempt, onClosed, setCanClose, setChild, setContentHeight, setContentWidth, setDefaultWidget, setFocusWidget, setFollowsContentSize, setPresentationMode, setTitle

Methods inherited from class org.gnome.gtk.Widget.Builder

onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, setCanFocus, setCanTarget, setCssClasses, setCssName, setCursor, setFocusable, setFocusOnClick, setHalign, setHasTooltip, setHeightRequest, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setReceivesDefault, setSensitive, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidthRequest

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible.Builder

setAccessibleRole

Methods inherited from interface io.github.jwharm.javagi.gobject.BuilderInterface

addBuilderProperty, connect, connect, getArena

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public AboutDialog build()

Finish building the AboutDialog object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to AboutDialog.

Overrides:

build in class Dialog.Builder<B extends AboutDialog.Builder<B>>

Returns:

a new instance of AboutDialog with the properties that were set in the Builder object.

setApplicationIcon

public B setApplicationIcon(String applicationIcon)

The name of the application icon.

The icon is displayed at the top of the main page.

Parameters:

applicationIcon - the value for the application-icon property

Returns:

the Builder instance is returned, to allow method chaining

setApplicationName

public B setApplicationName(String applicationName)

The name of the application.

The name is displayed at the top of the main page.

Parameters:

applicationName - the value for the application-name property

Returns:

the Builder instance is returned, to allow method chaining

setArtists

public B setArtists(String[] artists)

The list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

• AboutDialog:developers
• AboutDialog:designers
• AboutDialog:documenters
• AboutDialog:translator-credits
• AboutDialog.addCreditSection(java.lang.String, java.lang.String[])
• AboutDialog.addAcknowledgementSection(java.lang.String, java.lang.String[])

Parameters:

artists - the value for the artists property

Returns:

the Builder instance is returned, to allow method chaining

setComments

public B setComments(String comments)

The comments about the application.

Comments will be shown on the Details page, above links.

Unlike Gtk.AboutDialog:comments, this string can be long and detailed. It can also contain links and Pango markup.

Parameters:

comments - the value for the comments property

Returns:

the Builder instance is returned, to allow method chaining

setCopyright

public B setCopyright(String copyright)

The copyright information.

This should be a short string of one or two lines, for example: © 2022 Example.

The copyright information will be displayed on the Legal page, above the application license.

AboutDialog.addLegalSection(java.lang.String, java.lang.String, org.gnome.gtk.License, java.lang.String) can be used to add copyright information for the application dependencies or other components.

Parameters:

copyright - the value for the copyright property

Returns:

the Builder instance is returned, to allow method chaining

setDebugInfo

public B setDebugInfo(String debugInfo)

The debug information.

Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the application.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, AboutDialog:debug-info-filename would be used as the suggested filename.

Debug information cannot contain markup or links.

Parameters:

debugInfo - the value for the debug-info property

Returns:

the Builder instance is returned, to allow method chaining

setDebugInfoFilename

public B setDebugInfoFilename(String debugInfoFilename)

The debug information filename.

It will be used as the suggested filename when saving debug information to a file.

See AboutDialog:debug-info.

Parameters:

debugInfoFilename - the value for the debug-info-filename property

Returns:

the Builder instance is returned, to allow method chaining

setDesigners

public B setDesigners(String[] designers)

The list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

• AboutDialog:developers
• AboutDialog:artists
• AboutDialog:documenters
• AboutDialog:translator-credits
• AboutDialog.addCreditSection(java.lang.String, java.lang.String[])
• AboutDialog.addAcknowledgementSection(java.lang.String, java.lang.String[])

Parameters:

designers - the value for the designers property

Returns:

the Builder instance is returned, to allow method chaining

setDeveloperName

public B setDeveloperName(String developerName)

The developer name.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like "AppName team", "AppName developers" or "The AppName project", and the individual contributors can be listed on the Credits page, with AboutDialog:developers and related properties.

Parameters:

developerName - the value for the developer-name property

Returns:

the Builder instance is returned, to allow method chaining

setDevelopers

public B setDevelopers(String[] developers)

The list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

• AboutDialog:designers
• AboutDialog:artists
• AboutDialog:documenters
• AboutDialog:translator-credits
• AboutDialog.addCreditSection(java.lang.String, java.lang.String[])
• AboutDialog.addAcknowledgementSection(java.lang.String, java.lang.String[])

Parameters:

developers - the value for the developers property

Returns:

the Builder instance is returned, to allow method chaining

setDocumenters

public B setDocumenters(String[] documenters)

The list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

• AboutDialog:developers
• AboutDialog:designers
• AboutDialog:artists
• AboutDialog:translator-credits
• AboutDialog.addCreditSection(java.lang.String, java.lang.String[])
• AboutDialog.addAcknowledgementSection(java.lang.String, java.lang.String[])

Parameters:

documenters - the value for the documenters property

Returns:

the Builder instance is returned, to allow method chaining

setIssueUrl

public B setIssueUrl(String issueUrl)

The URL for the application's issue tracker.

The issue tracker link is displayed on the main page.

Parameters:

issueUrl - the value for the issue-url property

Returns:

the Builder instance is returned, to allow method chaining

setLicense

public B setLicense(String license)

The license text.

This can be used to set a custom text for the license if it can't be set via AboutDialog:license-type.

When set, AboutDialog:license-type will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

AboutDialog.addLegalSection(java.lang.String, java.lang.String, org.gnome.gtk.License, java.lang.String) can be used to add license information for the application dependencies or other components.

Parameters:

license - the value for the license property

Returns:

the Builder instance is returned, to allow method chaining

setLicenseType

public B setLicenseType(License licenseType)

The license type.

Allows to set the application's license froma list of known licenses.

If the application's license is not in the list, AboutDialog:license can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If set to GTK_LICENSE_UNKNOWN, no information will be displayed.

If the license type is different from GTK_LICENSE_CUSTOM. AboutDialog:license will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

AboutDialog.addLegalSection(java.lang.String, java.lang.String, org.gnome.gtk.License, java.lang.String) can be used to add license information for the application dependencies or other components.

Parameters:

licenseType - the value for the license-type property

Returns:

the Builder instance is returned, to allow method chaining

setReleaseNotes

public B setReleaseNotes(String releaseNotes)

The release notes of the application.

Release notes are displayed on the the What's New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

• Paragraph (<p>)
• Ordered list (<ol>), with list items (<li>)
• Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis (<em>) and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AdwAboutDialog displays the version above the release notes. If set, the AboutDialog:release-notes-version of the property will be used as the version; otherwise, AboutDialog:version is used.

Parameters:

releaseNotes - the value for the release-notes property

Returns:

the Builder instance is returned, to allow method chaining

setReleaseNotesVersion

public B setReleaseNotesVersion(String releaseNotesVersion)

The version described by the application's release notes.

The release notes version is displayed on the What's New page, above the release notes.

If not set, AboutDialog:version will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See AboutDialog:release-notes.

Parameters:

releaseNotesVersion - the value for the release-notes-version property

Returns:

the Builder instance is returned, to allow method chaining

setSupportUrl

public B setSupportUrl(String supportUrl)

The URL of the application's support page.

The support page link is displayed on the main page.

Parameters:

supportUrl - the value for the support-url property

Returns:

the Builder instance is returned, to allow method chaining

setTranslatorCredits

public B setTranslatorCredits(String translatorCredits)

The translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

• AboutDialog:developers
• AboutDialog:designers
• AboutDialog:artists
• AboutDialog:documenters
• AboutDialog.addCreditSection(java.lang.String, java.lang.String[])
• AboutDialog.addAcknowledgementSection(java.lang.String, java.lang.String[])

Parameters:

translatorCredits - the value for the translator-credits property

Returns:

the Builder instance is returned, to allow method chaining

setVersion

public B setVersion(String version)

The version of the application.

The version is displayed on the main page.

If AboutDialog:release-notes-version is not set, the version will also be displayed above the release notes on the What's New page.

Parameters:

version - the value for the version property

Returns:

the Builder instance is returned, to allow method chaining

setWebsite

public B setWebsite(String website)

The URL of the application's website.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content.

Applications can add other links below, see AboutDialog.addLink(java.lang.String, java.lang.String).

Parameters:

website - the value for the website property

Returns:

the Builder instance is returned, to allow method chaining

onActivateLink

public B onActivateLink(AboutDialog.ActivateLinkCallback handler)

Emitted when a URL is activated.

Applications may connect to it to override the default behavior, which is to call Gtk.showUri(org.gnome.gtk.Window, java.lang.String, int).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• AboutDialog.ActivateLinkCallback.run(java.lang.String)