com.izforge.izpack.util.os
Class Shortcut

java.lang.Object
  com.izforge.izpack.util.os.Shortcut

Direct Known Subclasses:

Unix_Shortcut, Win_Shortcut

public abstract class Shortcut
extends Object

This class represents a shortcut in a operating system independent way. OS specific subclasses are used to implement the necessary mapping from this generic API to the classes that reflect the system dependent AIP.

Version:

0.0.1 / 3/4/02

Author:

Elmar Grom

See Also:

TargetFactory

Field Summary

static int	ALL_USERS ALL_USERS = 2 (identifies the user type as valid for all users)
static int	APPLICATIONS APPLICATIONS = 1
static int	CURRENT_USER CURRENT_USER = 1 (identifies the user type as the current user)
static int	DESKTOP DESKTOP = 3
static int	HIDE HIDE = 0 (Hide the window when starting.)
static int	MAXIMIZED MAXIMIZED = 3 (Show the window maximized when starting.)
static int	MINIMIZED MINIMIZED = 2
static int	NORMAL NORMAL = 1 Show the window 'normal' when starting.
static int	START_MENU START_MENU = 2
static int	START_UP START_UP = 4
protected UninstallData	uninstaller internal field UninstallData uninstaller

Constructor Summary

Shortcut()

Method Summary

void	cleanUp() Clean Up Method to do some cleanups after Shortcut Creation.
void	execPostAction() Dummy Method especially for the Unix Root User.
String	getBasePath() Returns the base path of the shortcut depending on type.
Boolean	getCreateForAll() Gets the create for All Flag
abstract String	getFileName() Subclass implementations return the fully qualified file name under which the link is saved on disk.
int	getHotkey() Gets the link hotKey
abstract String	getIconLocation() Returns the path of the shortcut icon that will be shown on the desktop.
abstract int	getLinkType() Gets the type of link types are: DESKTOP APPLICATIONS START_MENU START_UP
abstract List<String>	getProgramGroups(int userType) Returns a list of currently existing program groups, based on the requested type.
abstract String	getProgramsFolder(int current_user) Gets the Programs Folder for the given User.
boolean	getRunAsAdministrator() Determines if the shortcut target should be run with administrator privileges.
int	getShowCommand()
abstract int	getUserType() Gets the user type for the link
String	getWorkingDirectory() Gets the working directory for the link target.
abstract void	initialize(int type, String name) This method initializes the object.
abstract boolean	multipleUsers() Returns true if the target OS supports current user and all users.
abstract void	save() Saves this link.
abstract void	setArguments(String arguments) Sets the command line arguments that will be passed to the target when the link is activated.
void	setCategories(String theCategories) Sets the Categories Field On Unixes
void	setCreateForAll(Boolean aCreateForAll) Sets the flag which indicates, that this should created for all.
abstract void	setDescription(String description) Sets the description string that is used to identify the link in a menu or on the desktop.
void	setEncoding(String string) Sets the Encoding
void	setHotkey(int hotkey) Sets the link hotKey
abstract void	setIconLocation(String path, int index) Sets the path of the shortcut icon that will be shown on the desktop.
void	setKdeSubstUID(String string) This sets the setKdeSubstUID
void	setKdeUserName(String string) This sets the KdeUserName
abstract void	setLinkName(String name) Sets the name shown in a menu or on the desktop for the link.
abstract void	setLinkType(int type) Sets the type of link
void	setMimetype(String string) This sets the Mimetype
abstract void	setProgramGroup(String groupName) Sets the name of the program group this ShellLinbk should be placed in.
void	setRunAsAdministrator(boolean runAsAdministrator) Determines if the shortcut target should be run with administrator privileges.
abstract void	setShowCommand(int show) Sets the show command that is passed to the target application when the link is activated.
abstract void	setTargetPath(String path) Sets the absolute path to the shortcut target.
void	setTerminal(String string) Sets the terminal
void	setTerminalOptions(String string) This sets the terminals-options
void	setTryExec(String aTryExec) Sets the TryExecField on Unixes.
void	setType(String string) This sets the shortcut type
void	setUninstaller(UninstallData theUninstaller) Sets the Uninstaller field with the unique Uninstaller Instance.
void	setURL(String string) This sets the URL
abstract void	setUserType(int type) Sets the user type for the link
abstract void	setWorkingDirectory(String dir) Sets the working directory for the link target.
abstract boolean	supported() Determines if a specific instance of this class supports the creation of shortcuts.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATIONS

public static final int APPLICATIONS

APPLICATIONS = 1

See Also:

Constant Field Values

START_MENU

public static final int START_MENU

START_MENU = 2

See Also:

Constant Field Values

DESKTOP

public static final int DESKTOP

DESKTOP = 3

See Also:

Constant Field Values

START_UP

public static final int START_UP

START_UP = 4

See Also:

Constant Field Values

HIDE

public static final int HIDE

HIDE = 0 (Hide the window when starting.)

See Also:

Constant Field Values

NORMAL

public static final int NORMAL

NORMAL = 1 Show the window 'normal' when starting. Usually restores the window properties at the last shut-down.

See Also:

Constant Field Values

MINIMIZED

public static final int MINIMIZED

MINIMIZED = 2

See Also:

Constant Field Values

MAXIMIZED

public static final int MAXIMIZED

MAXIMIZED = 3 (Show the window maximized when starting.)

See Also:

Constant Field Values

CURRENT_USER

public static final int CURRENT_USER

CURRENT_USER = 1 (identifies the user type as the current user)

See Also:

Constant Field Values

ALL_USERS

public static final int ALL_USERS

ALL_USERS = 2 (identifies the user type as valid for all users)

See Also:

Constant Field Values

uninstaller

protected UninstallData uninstaller

internal field UninstallData uninstaller

Constructor Detail

Shortcut

public Shortcut()

Method Detail

initialize

public abstract void initialize(int type,
                                String name)
                         throws Exception

This method initializes the object. It is used as a replacement for the contructor because of the way it is instantiated through the TargetFactory.

Parameters:

type - the type or classification of the program group in which the link should exist.

name - the name of the shortcut.

Throws:

Exception

getBasePath

public String getBasePath()
                   throws Exception

Returns the base path of the shortcut depending on type. The base path is the directory that the short cut, (or its program group) will be created in. For instance, on Windows NT, a shortcut with user-type ALL_USERS, and link-type DESKTOP might have the base path "C:\Program Files\All Users\Desktop"

Throws:

Exception

See Also:

setLinkType(int), setUserType(int)

getProgramGroups

public abstract List<String> getProgramGroups(int userType)

Returns a list of currently existing program groups, based on the requested type. For example if the type is APPLICATIONS then all the names of the program groups in the Start Menu\Programs menu would be returned.

Parameters:

userType - the type of user for the program group set.

Returns:

a Vector of String objects that represent the names of the existing program groups. It is theoretically possible that this list is empty.

See Also:

APPLICATIONS, START_MENU

getFileName

public abstract String getFileName()

Subclass implementations return the fully qualified file name under which the link is saved on disk. Note: this method returns valid results only if the instance was created from a file on disk or after a successful save operation. An instance of this class returns an empty string.

Returns:

an empty String

multipleUsers

public abstract boolean multipleUsers()

Returns true if the target OS supports current user and all users.

Returns:

true if the target OS supports current and all users.

supported

public abstract boolean supported()

Determines if a specific instance of this class supports the creation of shortcuts. The use of this method might seem odd, since one would not implement a flavor of this class that does not actually support the creation of shortcuts. In other words all flavors will in all probability return true. The only version that can be expected to return false is this class itself, since it has no actual implementation for shortcut creation. This is left to OS specific flavors. If the installer is launched on a unsupported OS there will be no appropriate flavor of this class, which will cause this class itself to be instantiated. The client code can now determine by calling this method if the active OS is supported and take appropriate action.

Returns:

true if the creation of shortcuts is supported, false if this is not supported.

setArguments

public abstract void setArguments(String arguments)

Sets the command line arguments that will be passed to the target when the link is activated.

Parameters:

arguments - the command line arguments

setDescription

public abstract void setDescription(String description)

Sets the description string that is used to identify the link in a menu or on the desktop.

Parameters:

description - the descriptiojn string

setIconLocation

public abstract void setIconLocation(String path,
                                     int index)

Sets the path of the shortcut icon that will be shown on the desktop.

Parameters:

path - a fully qualified file name of a file that contains the icon.

index - the index of the specific icon to use in the file. If there is only one icon in the file, use an index of 0.

getIconLocation

public abstract String getIconLocation()

Returns the path of the shortcut icon that will be shown on the desktop.

Returns:

icon path

setProgramGroup

public abstract void setProgramGroup(String groupName)

Sets the name of the program group this ShellLinbk should be placed in.

Parameters:

groupName - the name of the program group

setShowCommand

public abstract void setShowCommand(int show)

Sets the show command that is passed to the target application when the link is activated. The show command determines if the the window will be restored to the previous size, minimized, maximized or visible at all.

Note:
Using HIDE will cause the target window not to show at all. There is not even a button on the taskbar. This is a very useful setting when batch files are used to launch a Java application as it will then appear to run just like any native Windows application.

Parameters:

show - the show command. Valid settings are:

• HIDE
• NORMAL
• MINIMIZED
• MAXIMIZED

See Also:

getShowCommand()

getShowCommand

public int getShowCommand()

setTargetPath

public abstract void setTargetPath(String path)

Sets the absolute path to the shortcut target.

Parameters:

path - the fully qualified file name of the target

setWorkingDirectory

public abstract void setWorkingDirectory(String dir)

Sets the working directory for the link target.

Parameters:

dir - the working directory

getWorkingDirectory

public String getWorkingDirectory()

Gets the working directory for the link target.

Returns:

the working directory.

setLinkName

public abstract void setLinkName(String name)

Sets the name shown in a menu or on the desktop for the link.

Parameters:

name - The name that the link should display on a menu or on the desktop. Do not include a file extension.

getLinkType

public abstract int getLinkType()

Gets the type of link types are:

• DESKTOP
• APPLICATIONS
• START_MENU
• START_UP

setLinkType

public abstract void setLinkType(int type)
                          throws IllegalArgumentException,
                                 UnsupportedEncodingException

Sets the type of link

Parameters:

type - The type of link desired. The following values can be set:

• DESKTOP
• APPLICATIONS
• START_MENU
• START_UP

Throws:

IllegalArgumentException - if an an invalid type is passed

UnsupportedEncodingException

setUserType

public abstract void setUserType(int type)

Sets the user type for the link

Parameters:

type - the type of user for the link.

See Also:

CURRENT_USER, ALL_USERS

getUserType

public abstract int getUserType()

Gets the user type for the link

Returns:

userType

See Also:

CURRENT_USER, ALL_USERS

setRunAsAdministrator

public void setRunAsAdministrator(boolean runAsAdministrator)

Determines if the shortcut target should be run with administrator privileges.

Parameters:

runAsAdministrator - if true, run the target with administrator privileges.

getRunAsAdministrator

public boolean getRunAsAdministrator()

Determines if the shortcut target should be run with administrator privileges.

Returns:

true, if the target will run with administrator privileges

save

public abstract void save()
                   throws Exception

Saves this link.

Throws:

Exception - if problems are encountered

getHotkey

public int getHotkey()

Gets the link hotKey

Returns:

int hotKey

setHotkey

public void setHotkey(int hotkey)

Sets the link hotKey

Parameters:

hotkey -

setEncoding

public void setEncoding(String string)

Sets the Encoding

Parameters:

string -

setMimetype

public void setMimetype(String string)

This sets the Mimetype

Parameters:

string -

setTerminal

public void setTerminal(String string)

Sets the terminal

Parameters:

string -

setTerminalOptions

public void setTerminalOptions(String string)

This sets the terminals-options

Parameters:

string -

setType

public void setType(String string)

This sets the shortcut type

Parameters:

string -

setKdeUserName

public void setKdeUserName(String string)

This sets the KdeUserName

Parameters:

string - The UserName

setKdeSubstUID

public void setKdeSubstUID(String string)

This sets the setKdeSubstUID

Parameters:

string - exactly "true" or "false" or nothing

setURL

public void setURL(String string)

This sets the URL

Parameters:

string -

getProgramsFolder

public abstract String getProgramsFolder(int current_user)

Gets the Programs Folder for the given User. This is where to create subfolders or to place or create shortcuts.

Parameters:

current_user - one of current or all

Returns:

The Foldername or null on unsupported platforms.

setCreateForAll

public void setCreateForAll(Boolean aCreateForAll)

Sets the flag which indicates, that this should created for all.

Parameters:

aCreateForAll - A Flag - Set to true, if to create for All.

getCreateForAll

public Boolean getCreateForAll()

Gets the create for All Flag

Returns:

Returns True if this should be for all.

setCategories

public void setCategories(String theCategories)

Sets the Categories Field On Unixes

Parameters:

theCategories - the categories

setTryExec

public void setTryExec(String aTryExec)

Sets the TryExecField on Unixes.

Parameters:

aTryExec - the try exec command

setUninstaller

public void setUninstaller(UninstallData theUninstaller)

Sets the Uninstaller field with the unique Uninstaller Instance.

Parameters:

theUninstaller - the unique instance

execPostAction

public void execPostAction()

Dummy Method especially for the Unix Root User.

cleanUp

public void cleanUp()

Clean Up Method to do some cleanups after Shortcut Creation.
currently unused.