|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.izforge.izpack.util.os.Shortcut
public class 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
ALL_USERS = 2 (identifies the user type as valid for all users) |
static int |
APPLICATIONS
APPLICATIONS = 1 |
private java.lang.Boolean |
createForAll
indicates that this shortcut should be created for all users or only me * |
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. |
java.lang.String |
getBasePath()
Returns the base path of the shortcut depending on type. |
java.lang.Boolean |
getCreateForAll()
Gets the create for All Flag |
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. |
int |
getHotkey()
Gets the link hotKey |
java.lang.String |
getIconLocation()
returns icon Location |
int |
getLinkType()
Gets the type of link types are: DESKTOP
APPLICATIONS
START_MENU
START_UP
|
java.util.Vector<java.lang.String> |
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 Programs Folder for the given User. |
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 |
setCategories(java.lang.String theCategories)
Sets the Categories Field On Unixes |
void |
setCreateForAll(java.lang.Boolean aCreateForAll)
Sets the flag which indicates, that this should created for all. |
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 |
setEncoding(java.lang.String string)
Sets the Encoding |
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 |
setKdeSubstUID(java.lang.String string)
This sets the setKdeSubstUID |
void |
setKdeUserName(java.lang.String string)
This sets the KdeUserName |
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 |
setMimetype(java.lang.String string)
This sets the Mimetype |
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 |
setTerminal(java.lang.String string)
Sets the terminal |
void |
setTerminalOptions(java.lang.String string)
This sets the terminals-options |
void |
setTryExec(java.lang.String aTryExec)
Sets the TryExecField on Unixes. |
void |
setType(java.lang.String string)
This sets the shortcut type |
void |
setUninstaller(UninstallData theUninstaller)
Sets the Uninstaller field with the unique Uninstaller Instance. |
void |
setURL(java.lang.String string)
This sets the URL |
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
private java.lang.Boolean createForAll
protected UninstallData uninstaller
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.lang.String getBasePath() throws java.lang.Exception
java.lang.Exception
setLinkType(int)
,
setUserType(int)
public java.util.Vector<java.lang.String> getProgramGroups(int userType)
APPLICATIONS
then all the names of the program groups in the
Start Menu\Programs 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, false
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 java.lang.String getIconLocation()
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 int getShowCommand()
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 java.lang.String getWorkingDirectory()
public 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 int getLinkType()
public void setLinkType(int type) throws java.lang.IllegalArgumentException, java.io.UnsupportedEncodingException
type
- The type of link desired. The following values can be set:java.lang.IllegalArgumentException
- if an an invalid type is passed
java.io.UnsupportedEncodingException
public void setUserType(int type)
type
- the type of user for the link.CURRENT_USER
,
ALL_USERS
public int getUserType()
CURRENT_USER
,
ALL_USERS
public void save() throws java.lang.Exception
java.lang.Exception
- if problems are encounteredpublic int getHotkey()
public void setHotkey(int hotkey)
hotkey
- public void setEncoding(java.lang.String string)
string
- public void setMimetype(java.lang.String string)
string
- public void setTerminal(java.lang.String string)
string
- public void setTerminalOptions(java.lang.String string)
string
- public void setType(java.lang.String string)
string
- public void setKdeUserName(java.lang.String string)
string
- The UserNamepublic void setKdeSubstUID(java.lang.String string)
string
- exactly "true" or "false" or nothingpublic void setURL(java.lang.String string)
string
- public java.lang.String getProgramsFolder(int current_user)
current_user
- one of current or all
public void setCreateForAll(java.lang.Boolean aCreateForAll)
aCreateForAll
- A Flag - Set to true, if to create for All.public java.lang.Boolean getCreateForAll()
public void setCategories(java.lang.String theCategories)
theCategories
- the categoriespublic void setTryExec(java.lang.String aTryExec)
aTryExec
- the try exec commandpublic void setUninstaller(UninstallData theUninstaller)
theUninstaller
- the unique instancepublic void execPostAction()
public void cleanUp()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |