|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.izforge.izpack.util.os.Shortcut
com.izforge.izpack.util.os.Win_Shortcut
This is the Microsoft Windows specific implementation of Shortcut
.
Field Summary | |
private ShellLink |
shortcut
|
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 | |
Win_Shortcut()
|
Method Summary | |
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. |
java.util.Vector |
getProgramGroups(int userType)
Returns a list of currently existing program groups, based on the requested type. |
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 |
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
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 |
private ShellLink shortcut
Constructor Detail |
public Win_Shortcut()
Method Detail |
public void initialize(int type, java.lang.String name) throws java.lang.Exception
TargetFactory
.
initialize
in class Shortcut
type
- the type or classification of the program group in which
the link should exist. The following types are recognized:
name
- the name of the shortcut.
java.lang.Exception
public java.util.Vector getProgramGroups(int userType)
APPLICATIONS
then
all the names of the program groups in the applications menu would be
returned.
getProgramGroups
in class Shortcut
userType
- the type of user for the program group set.
Vector
of String
objects that
represent the names of the existing program groups. It is
theoretically possible that this list is empty.Shortcut.APPLICATIONS
,
Shortcut.START_MENU
public java.lang.String getFileName()
getFileName
in class Shortcut
public java.lang.String getDirectoryCreated()
null
if no save operation was carried
out or there was no need to create a directory during the previous save
operation.
getDirectoryCreated
in class Shortcut
null
if no save operation was carried out or
there was no need to create a directory during the previous
save operation.public boolean multipleUsers()
true
if the target OS supports current user and
all users.
multipleUsers
in class Shortcut
true
if the target OS supports current and all users.public boolean supported()
Shortcut
supports the creation of shortcuts.
supported
in class Shortcut
true
public void setArguments(java.lang.String arguments)
setArguments
in class Shortcut
arguments
- the command line argumentspublic void setDescription(java.lang.String description)
setDescription
in class Shortcut
description
- the descriptiojn stringpublic void setIconLocation(java.lang.String path, int index)
setIconLocation
in class Shortcut
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.public void setProgramGroup(java.lang.String groupName)
setProgramGroup
in class Shortcut
groupName
- the name of the program grouppublic void setShowCommand(int show) throws java.lang.IllegalArgumentException
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.
setShowCommand
in class Shortcut
show
- the show command. Valid settings are: java.lang.IllegalArgumentException
#getShowCommand
public void setTargetPath(java.lang.String path)
setTargetPath
in class Shortcut
path
- the fully qualified file name of the targetpublic void setWorkingDirectory(java.lang.String dir)
setWorkingDirectory
in class Shortcut
dir
- the working directorypublic void setLinkName(java.lang.String name)
setLinkName
in class Shortcut
name
- The name that the link should display on a menu or on
the desktop. Do not include a file extension.public void setLinkType(int type) throws java.lang.IllegalArgumentException
setLinkType
in class Shortcut
type
- The type of link desired. The following values can be set:java.lang.IllegalArgumentException
- if an an invalid type is passedpublic void setUserType(int type)
setUserType
in class Shortcut
Shortcut.CURRENT_USER
,
Shortcut.ALL_USERS
public void save() throws java.lang.Exception
save
in class Shortcut
java.lang.Exception
- if problems are encountered
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |