com.izforge.izpack.util.os

Class Win_Shortcut

java.lang.Object

com.izforge.izpack.util.os.Shortcut

com.izforge.izpack.util.os.Win_Shortcut

public class Win_Shortcut
extends Shortcut

This is the Microsoft Windows specific implementation of Shortcut.

Version:

0.0.1 / 3/4/02

Author:

Elmar Grom

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLASS
private static java.lang.String	myClass
private ShellLink	shortcut
private static boolean	SUPPORTED SUPPORTED = true

Fields inherited from class com.izforge.izpack.util.os.Shortcut

ALL_USERS, APPLICATIONS, CURRENT_USER, DESKTOP, HIDE, MAXIMIZED, MINIMIZED, NORMAL, START_MENU, START_UP

Constructor Summary

Constructors

Constructor and Description
Win_Shortcut()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBasePath() Returns the base path of the shortcut depending on type.
java.lang.String	getDirectoryCreated() Returns the path of the directory where the link file is stored, if it was necessary during the previous save operation to create the directory.
java.lang.String	getFileName() Returns the fully qualified file name under which the link is saved on disk.
int	getHotkey() Gets the link hotKey
java.lang.String	getIconLocation() returns icon Location
int	getLinkType() Gets the type of link types are: Shortcut.DESKTOP Shortcut.APPLICATIONS Shortcut.START_MENU Shortcut.START_UP maps from ShellLink-types to Shortcut-types.
java.util.Vector	getProgramGroups(int userType) Returns a list of currently existing program groups, based on the requested type.
java.lang.String	getProgramsFolder(int current_user) Gets the Folders where to place the program-groups and their shortcuts, for the given usertype.
int	getShowCommand()
int	getUserType() Gets the user type for the link
java.lang.String	getWorkingDirectory() Gets the working directory for the link target.
void	initialize(int type, java.lang.String name) This method initializes the object.
boolean	multipleUsers() Returns true if the target OS supports current user and all users.
void	save() Saves this link.
void	setArguments(java.lang.String arguments) Sets the command line arguments that will be passed to the target when the link is activated.
void	setDescription(java.lang.String description) Sets the description string that is used to identify the link in a menu or on the desktop.
void	setHotkey(int hotkey) Sets the link hotKey
void	setIconLocation(java.lang.String path, int index) Sets the location of the icon that is shown for the shortcut on the desktop.
void	setLinkName(java.lang.String name) Sets the name shown in a menu or on the desktop for the link.
void	setLinkType(int type) Sets the type of link
void	setProgramGroup(java.lang.String groupName) Sets the name of the program group this ShellLinbk should be placed in.
void	setShowCommand(int show) Sets the show command that is passed to the target application when the link is activated.
void	setTargetPath(java.lang.String path) Sets the absolute path to the shortcut target.
void	setUserType(int type) Sets the user type for the link
void	setWorkingDirectory(java.lang.String dir) Sets the working directory for the link target.
boolean	supported() Signals that this flavor of Shortcut supports the creation of shortcuts.

Methods inherited from class com.izforge.izpack.util.os.Shortcut

getCreateForAll, setCreateForAll, setEncoding, setKdeSubstUID, setMimetype, setTerminal, setTerminalOptions, setType, setURL

Methods inherited from class java.lang.Object

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

Field Detail

shortcut

private ShellLink shortcut

myClass

private static java.lang.String myClass

CLASS

private static final java.lang.String CLASS

See Also:

Constant Field Values

SUPPORTED

private static final boolean SUPPORTED

SUPPORTED = true

See Also:

Constant Field Values

Constructor Detail

Win_Shortcut

public Win_Shortcut()

Method Detail

initialize

public void initialize(int type,
              java.lang.String name)
                throws java.lang.Exception

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

Overrides:

initialize in class Shortcut

Parameters:

type - the type or classification of the program group in which the link should exist. The following types are recognized:

• Shortcut.APPLICATIONS
• Shortcut.START_MENU
• Shortcut.DESKTOP
• Shortcut.START_UP

name - the name of the shortcut.

Throws:

java.lang.Exception

getBasePath

public java.lang.String getBasePath()
                             throws java.lang.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"

Overrides:

getBasePath in class Shortcut

Throws:

java.lang.Exception

See Also:

setLinkType(int), translates from ShellLink-UserTypes to Shortcut-UserTypes.

getProgramGroups

public java.util.Vector 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.

Overrides:

getProgramGroups in class Shortcut

Parameters:

userType - the type of user for the program group set. (as Shortcut.utype)

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:

Shortcut.APPLICATIONS, Shortcut.START_MENU

getFileName

public java.lang.String getFileName()

Returns 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.

Overrides:

getFileName in class Shortcut

Returns:

the fully qualified file name for the shell link

getDirectoryCreated

public java.lang.String getDirectoryCreated()

Returns the path of the directory where the link file is stored, if it was necessary during the previous save operation to create the directory. This method returns null if no save operation was carried out or there was no need to create a directory during the previous save operation.

Overrides:

getDirectoryCreated in class Shortcut

Returns:

the path of the directory where the link file is stored or null if no save operation was carried out or there was no need to create a directory during the previous save operation.

multipleUsers

public boolean multipleUsers()

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

Overrides:

multipleUsers in class Shortcut

Returns:

true if the target OS supports current and all users.

supported

public boolean supported()

Signals that this flavor of Shortcut supports the creation of shortcuts.

Overrides:

supported in class Shortcut

Returns:

always true

setArguments

public void setArguments(java.lang.String arguments)

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

Overrides:

setArguments in class Shortcut

Parameters:

arguments - the command line arguments

setDescription

public void setDescription(java.lang.String description)

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

Overrides:

setDescription in class Shortcut

Parameters:

description - the descriptiojn string

setIconLocation

public void setIconLocation(java.lang.String path,
                   int index)

Sets the location of the icon that is shown for the shortcut on the desktop.

Overrides:

setIconLocation in class Shortcut

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 java.lang.String getIconLocation()

returns icon Location

Overrides:

getIconLocation in class Shortcut

Returns:

iconLocation

setProgramGroup

public void setProgramGroup(java.lang.String groupName)

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

Overrides:

setProgramGroup in class Shortcut

Parameters:

groupName - the name of the program group

setShowCommand

public void setShowCommand(int show)
                    throws java.lang.IllegalArgumentException

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.

Overrides:

setShowCommand in class Shortcut

Parameters:

show - the show command. Valid settings are:

• Shortcut.HIDE
• Shortcut.NORMAL
• Shortcut.MINIMIZED
• Shortcut.MAXIMIZED

Throws:

java.lang.IllegalArgumentException

See Also:

internally maps from Shortcut. to ShellLink.

getShowCommand

public int getShowCommand()

Overrides:

getShowCommand in class Shortcut

setTargetPath

public void setTargetPath(java.lang.String path)

Sets the absolute path to the shortcut target.

Overrides:

setTargetPath in class Shortcut

Parameters:

path - the fully qualified file name of the target

setWorkingDirectory

public void setWorkingDirectory(java.lang.String dir)

Sets the working directory for the link target.

Overrides:

setWorkingDirectory in class Shortcut

Parameters:

dir - the working directory

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Gets the working directory for the link target.

Overrides:

getWorkingDirectory in class Shortcut

Returns:

the working directory.

setLinkName

public void setLinkName(java.lang.String name)

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

Overrides:

setLinkName in class Shortcut

Parameters:

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

getLinkType

public int getLinkType()

Gets the type of link types are:

• Shortcut.DESKTOP
• Shortcut.APPLICATIONS
• Shortcut.START_MENU
• Shortcut.START_UP

maps from ShellLink-types to Shortcut-types.

Overrides:

getLinkType in class Shortcut

setLinkType

public void setLinkType(int type)
                 throws java.lang.IllegalArgumentException,
                        java.io.UnsupportedEncodingException

Sets the type of link

Overrides:

setLinkType in class Shortcut

Parameters:

type - The type of link desired. The following values can be set:
(note APPLICATION on Windows is 'Start Menu\Programs') APPLICATION is a Mac term.

• Shortcut.DESKTOP
• Shortcut.APPLICATIONS
• Shortcut.START_MENU
• Shortcut.START_UP

Throws:

java.lang.IllegalArgumentException - if an an invalid type is passed

java.io.UnsupportedEncodingException

getUserType

public int getUserType()

Gets the user type for the link

Overrides:

getUserType in class Shortcut

Returns:

userType

See Also:

Shortcut.CURRENT_USER, Shortcut.ALL_USERS

setUserType

public void setUserType(int type)

Sets the user type for the link

Overrides:

setUserType in class Shortcut

Parameters:

type - the type of user for the link.

See Also:

Shortcut.CURRENT_USER, if the linkPath for that type is empty, refuse to set.

save

public void save()
          throws java.lang.Exception

Saves this link.

Overrides:

save in class Shortcut

Throws:

java.lang.Exception - if problems are encountered

getHotkey

public int getHotkey()

Gets the link hotKey

Overrides:

getHotkey in class Shortcut

Returns:

int hotKey

setHotkey

public void setHotkey(int hotkey)

Sets the link hotKey

Overrides:

setHotkey in class Shortcut

Parameters:

hotkey - incoming 2 byte hotkey is: high byte modifier: SHIFT = 0x01 CONTROL= 0x02 ALT = 0x04 EXT = 0x08 lower byte contains ascii letter. ie 0x0278 represents CTRL+x 0x068a represents CTRL+ALT+z

getProgramsFolder

public java.lang.String getProgramsFolder(int current_user)

Gets the Folders where to place the program-groups and their shortcuts, for the given usertype.

Overrides:

getProgramsFolder in class Shortcut

Parameters:

current_user - one of current or all

Returns:

The Foldername or null on unsupported platforms.

Throws:

java.io.UnsupportedEncodingException

See Also:

Shortcut.getProgramsFolder(int)