org.freedesktop.desktopentry

Class DesktopEntry

java.lang.Object

org.freedesktop.AbstractFreedesktopEntity

org.freedesktop.desktopentry.DesktopEntry

All Implemented Interfaces:

FreedesktopEntity, FreedesktopResource

public class DesktopEntry
extends AbstractFreedesktopEntity

Implements the Desktop Entry Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DesktopEntry.Type There are 4 types of desktop entries: Application, Link, FSDevice and Directory.

Field Summary

Fields inherited from class org.freedesktop.AbstractFreedesktopEntity

example

Constructor Summary

Constructors

Constructor and Description
DesktopEntry(org.apache.commons.vfs2.FileObject... base)

Method Summary

Modifier and Type	Method and Description
Collection<String>	getActions() Additional actions possible.Will always return at least an empty collection.
Collection<String>	getCategories() Categories in which the entry should be shown in a menu (for possible values see the Desktop Menu Specification).
String	getDev() Get the device to mount.
String	getExec() Program to execute, possibly with arguments.
Collection<String>	getFilePattern() A list of regular expressions to match against for a file manager to determine if this entry's icon should be displayed.
String	getFSType() Get the type of file system to try and mount.
String	getGenericName() Generic name of the application, for example "Web Browser".
String	getIcon() Icon to display in file manager, menus, etc.
String	getIcon(Locale locale) Icon to display in file manager, menus, etc.
String	getIcon(String language) Icon to display in file manager, menus, etc.
Collection<String>	getMimeType() Get a list of all the Mime types the applications supported by this entry.
String	getMountPoint() Get the mount point of the device.
String	getPath() If entry is of type Application, the working directory to run the program in.
String	getSortOrder() Get the order in which to display files.
String	getStartupWMClass() The window manager class or name hint (see the Startup Notification Protocol Specification for more details) to use for startup notifocation (see the Startup Notification Protocol Specification for more details).
String	getSwallowExec() Program to exec if swallowed app is clicked.
String	getSwallowTitle() If entry is swallowed onto the panel, this should be the title of the window.
String	getSwallowTitle(Locale locale) If entry is swallowed onto the panel, this should be the title of the window.
String	getSwallowTitle(String language) If entry is swallowed onto the panel, this should be the title of the window.
String	getTryExec() File name of a binary on disk used to determine if the program is actually installed.
DesktopEntry.Type	getType() There are 4 types of desktop entries: Application, Link, FSDevice and Directory.
String	getUnmountIcon() Icon to display when device is not mounted.
String	getUnmountIcon(Locale locale) Icon to display when device is not mounted.
String	getUnmountIcon(String language) Icon to display when device is not mounted.
URI	getURL() If entry is Link type, the URL to access.
String	getVersion() Version of Desktop Entry Specification (While the version field is not required to be present, it should be in all newer implementations of the Desktop Entry Specification.
protected void	initFromProperties(INIFile iniFile, Properties properties)
boolean	isHidden() Hidden should have been called Deleted.
boolean	isNoDisplay() NoDisplay means "this application exists, but don't display it in the menus".
boolean	isReadOnly() Get whether the device is read only or not.
boolean	isStartupNotify() If true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_LAUNCH_ID environment variable set (see the Startup Notification Protocol Specification for more details).
boolean	isTerminal() Whether the program runs in a terminal window.
protected void	load()

Methods inherited from class org.freedesktop.AbstractFreedesktopEntity

checkLoaded, getBase, getBases, getComment, getComment, getComment, getInternalName, getLocalisableField, getName, getName, getName, init, isLoaded, load, load, loadDefaults, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DesktopEntry

public DesktopEntry(org.apache.commons.vfs2.FileObject... base)
             throws IOException,
                    ParseException

Throws:

IOException

ParseException

Method Detail

getFilePattern

public Collection<String> getFilePattern()

A list of regular expressions to match against for a file manager to determine if this entry's icon should be displayed. Usually simply the name of the main executable and friends.

Returns:

file pattern

getType

public DesktopEntry.Type getType()

There are 4 types of desktop entries: Application, Link, FSDevice and Directory.

Returns:

type

getVersion

public String getVersion()

Version of Desktop Entry Specification (While the version field is not required to be present, it should be in all newer implementations of the Desktop Entry Specification. If the version number is not present, a "pre-standard" desktop entry file is to be assumed).

Returns:

version

isNoDisplay

public boolean isNoDisplay()

NoDisplay means "this application exists, but don't display it in the menus". This can be useful to e.g. associate this application with MIME types, so that it gets launched from a file manager (or other apps), without having a menu entry for it (there are tons of good reasons for this, including e.g. the netscape -remote, or kfmclient openURL kind of stuff).

Returns:

no display

getGenericName

public String getGenericName()

Generic name of the application, for example "Web Browser".

Returns:

generic name

getIcon

public String getIcon()

Icon to display in file manager, menus, etc. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Returns:

icon

getIcon

public String getIcon(Locale locale)

Icon to display in file manager, menus, etc. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Parameters:

locale - locale

Returns:

icon

getIcon

public String getIcon(String language)

Icon to display in file manager, menus, etc. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Parameters:

language - language

Returns:

icon

isHidden

public boolean isHidden()

Hidden should have been called Deleted. It means the user deleted (at his level) something that was present (at an upper level, e.g. in the system dirs). It's strictly equivalent to the .desktop file not existing at all, as far as that user is concerned. This can also be used to "uninstall" existing files (e.g. due to a renaming) - by letting make install install a file with Hidden=true in it.

Returns:

getTryExec

public String getTryExec()

File name of a binary on disk used to determine if the program is actually installed. If not, entry may not show in menus, etc. Will either return a non-empty string or null if the entry was not specified.

Returns:

try exec

getExec

public String getExec()

Program to execute, possibly with arguments. Will either return a non-empty string or null if the entry was not specified.

Returns:

exec

getPath

public String getPath()

If entry is of type Application, the working directory to run the program in. Will either return a non-empty string or null if the entry was not specified.

Returns:

path

isTerminal

public boolean isTerminal()

Whether the program runs in a terminal window.

Returns:

program runs in a terminal window

getSwallowTitle

public String getSwallowTitle()

If entry is swallowed onto the panel, this should be the title of the window.

Returns:

swallow title

getSwallowTitle

public String getSwallowTitle(Locale locale)

If entry is swallowed onto the panel, this should be the title of the window.

Parameters:

locale - locale

Returns:

swallow title

getSwallowTitle

public String getSwallowTitle(String language)

If entry is swallowed onto the panel, this should be the title of the window.

Parameters:

language - language

Returns:

swallow title

getSwallowExec

public String getSwallowExec()

Program to exec if swallowed app is clicked.

Returns:

swallow exec

getActions

public Collection<String> getActions()

Additional actions possible.Will always return at least an empty collection.

Returns:

additional actions

getMimeType

public Collection<String> getMimeType()

Get a list of all the Mime types the applications supported by this entry. Will always return at least an empty collection.

Returns:

mime types

getSortOrder

public String getSortOrder()

Get the order in which to display files. Will either return a non-empty string or null if the entry was not specified.

Returns:

sort order

getDev

public String getDev()

Get the device to mount. Will either return a non-empty string or null if the entry was not specified.

getFSType

public String getFSType()

Get the type of file system to try and mount. Will either return a non-empty string or null if the entry was not specified.

Returns:

file system type

getMountPoint

public String getMountPoint()

Get the mount point of the device. Will either return a non-empty string or null if the entry was not specified.

Returns:

mount point

isReadOnly

public boolean isReadOnly()

Get whether the device is read only or not.

Returns:

read only

getUnmountIcon

public String getUnmountIcon()

Icon to display when device is not mounted. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Returns:

icon

getUnmountIcon

public String getUnmountIcon(Locale locale)

Icon to display when device is not mounted. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Parameters:

locale - locale

Returns:

icon

getUnmountIcon

public String getUnmountIcon(String language)

Icon to display when device is not mounted. The the name will either be an absolute path, or the platform implementation-dependent icon name.

Parameters:

language - language

Returns:

icon

getURL

public URI getURL()

If entry is Link type, the URL to access.

Returns:

URL

getCategories

public Collection<String> getCategories()

Categories in which the entry should be shown in a menu (for possible values see the Desktop Menu Specification).

Returns:

categories

isStartupNotify

public boolean isStartupNotify()

If true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_LAUNCH_ID environment variable set (see the Startup Notification Protocol Specification for more details).

Returns:

startup notify

getStartupWMClass

public String getStartupWMClass()

The window manager class or name hint (see the Startup Notification Protocol Specification for more details) to use for startup notifocation (see the Startup Notification Protocol Specification for more details).

Returns:

startup window manager class

See Also:

isStartupNotify()

initFromProperties

protected void initFromProperties(INIFile iniFile,
                                  Properties properties)
                           throws IOException,
                                  ParseException

Specified by:

initFromProperties in class AbstractFreedesktopEntity

Throws:

IOException

ParseException

load

protected void load()
             throws IOException,
                    ParseException

Specified by:

load in class AbstractFreedesktopEntity

Throws:

IOException

ParseException