netx.jnlp

Class InformationDesc


public class InformationDesc
extends java.lang.Object

The information element.

Version:
$Revision: 1.9 $
Author:
Jon A. Maxwell (JAM) - initial author

Field Summary

static Object
DEFAULT
default description
static Object
ONE_LINE
one-line description
static Object
SHORT
short description
static Object
TOOLTIP
tooltip description

Constructor Summary

InformationDesc(JNLPFile jnlpFile, locales[] )
Create an information element object.

Method Summary

protected void
addItem(String key, Object value)
Add an information item (description, icon, etc) under a specified key name.
String
getDescription()
Returns the default description for the application.
String
getDescription(Object kind)
Returns the application's description of the specified type.
URL
getHomepage()
Returns the application's homepage.
URL
getIconLocation(Object kind, int width, int height)
Returns the URL of the icon closest to the specified size and kind.
IconDesc[]
getIcons(Object kind)
Returns the icons specified by the JNLP file.
protected Object
getItem(Object key)
Returns the last item matching the specified key.
protected List
getItems(Object key)
Returns all items matching the specified key.
JNLPFile
getJNLPFile()
Returns the JNLPFile the information is for.
Locale[]
getLocales()
Returns the locales for the information.
String
getTitle()
Returns the application's title.
String
getVendor()
Returns the application's vendor.
boolean
isOfflineAllowed()
Returns whether offline execution allowed.
boolean
isSharingAllowed()
Returns whether the resources specified in the JNLP file may be shared by more than one instance in the same JVM (JNLP extension).

Field Details

DEFAULT

public static final Object DEFAULT
default description

ONE_LINE

public static final Object ONE_LINE
one-line description

SHORT

public static final Object SHORT
short description

TOOLTIP

public static final Object TOOLTIP
tooltip description

Constructor Details

InformationDesc

public InformationDesc(JNLPFile jnlpFile,
                       locales[] )
Create an information element object.
Parameters:
jnlpFile - file that the information is for

Method Details

addItem

protected void addItem(String key,
                       Object value)
Add an information item (description, icon, etc) under a specified key name.

getDescription

public String getDescription()
Returns the default description for the application.

getDescription

public String getDescription(Object kind)
Returns the application's description of the specified type.
Parameters:
kind - one of Information.SHORT, Information.ONE_LINE, Information.TOOLTIP, Information.DEFAULT

getHomepage

public URL getHomepage()
Returns the application's homepage.

getIconLocation

public URL getIconLocation(Object kind,
                           int width,
                           int height)
Returns the URL of the icon closest to the specified size and kind. This method will not return an icon smaller than the specified width and height unless there are no other icons available.
Parameters:
kind - the kind of icon to get
width - desired width of icon
height - desired height of icon
Returns:
the closest icon by size or null if no icons declared

getIcons

public IconDesc[] getIcons(Object kind)
Returns the icons specified by the JNLP file.
Parameters:
kind - one of IconDesc.SELECTED, IconDesc.DISABLED, IconDesc.ROLLOVER, IconDesc.SPLASH, IconDesc.DEFAULT
Returns:
an array of zero of more IconDescs of the specified icon type

getItem

protected Object getItem(Object key)
Returns the last item matching the specified key.

getItems

protected List getItems(Object key)
Returns all items matching the specified key.

getJNLPFile

public JNLPFile getJNLPFile()
Returns the JNLPFile the information is for.

getLocales

public Locale[] getLocales()
Returns the locales for the information.

getTitle

public String getTitle()
Returns the application's title.

getVendor

public String getVendor()
Returns the application's vendor.

isOfflineAllowed

public boolean isOfflineAllowed()
Returns whether offline execution allowed.

isSharingAllowed

public boolean isSharingAllowed()
Returns whether the resources specified in the JNLP file may be shared by more than one instance in the same JVM (JNLP extension). This is an extension to the JNLP spec and will always return false for standard JNLP files.