|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.izforge.izpack.util.os.Shortcut
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.
TargetFactory
Field Summary | |
static int |
ALL_USERS
identifies the user type as valid for all users |
static int |
APPLICATIONS
|
static int |
CURRENT_USER
identifies the user type as the current user |
static int |
DESKTOP
|
static int |
HIDE
Hide the window when starting. |
static int |
MAXIMIZED
Show the window maximized when starting. |
static int |
MINIMIZED
Show the window minimized when starting. |
static int |
NORMAL
Show the window 'normal' when starting. |
static int |
START_MENU
|
static int |
START_UP
|
Constructor Summary | |
Shortcut()
|
Method Summary | |
java.lang.String |
getDirectoryCreated()
Subclass implementations return 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()
Subclass implementations return 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()
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 |
public static final int APPLICATIONS
public static final int START_MENU
public static final int DESKTOP
public static final int START_UP
public static final int HIDE
public static final int NORMAL
public static final int MINIMIZED
public static final int MAXIMIZED
public static final int CURRENT_USER
public static final int ALL_USERS
Constructor Detail |
public Shortcut()
Method Detail |
public void initialize(int type, java.lang.String name) throws java.lang.Exception
TargetFactory
.
type
- the type or classification of the program group in which
the link should exist.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.
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.APPLICATIONS
,
START_MENU
public java.lang.String getFileName()
String
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.
null
.public boolean multipleUsers()
true
if the target OS supports current user and
all users.
true
if the target OS supports current and all users.public boolean supported()
true
if the creation of shortcuts is supported,
flase
if this is not supported.public void setArguments(java.lang.String arguments)
arguments
- the command line argumentspublic void setDescription(java.lang.String description)
description
- the descriptiojn stringpublic void setIconLocation(java.lang.String path, int index)
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)
groupName
- the name of the program grouppublic void setShowCommand(int show)
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.
public void setTargetPath(java.lang.String path)
path
- the fully qualified file name of the targetpublic void setWorkingDirectory(java.lang.String dir)
dir
- the working directorypublic void setLinkName(java.lang.String name)
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
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)
CURRENT_USER
,
ALL_USERS
public void save() throws java.lang.Exception
java.lang.Exception
- if problems are encountered
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |