net.jimmc.jshortcut

Class JShellLink

java.lang.Object

net.jimmc.jshortcut.JShellLink

public class JShellLink
extends java.lang.Object

Provide access to shortcuts (shell links) from Java. The native library (jshortcut.dll) is loaded when JShellLink is first loaded. By default, JShellLink first looks for the native library in the PATH, using System.loadLibrary. If the native library is not found in the PATH, JShellLink then looks through each directory in the CLASSPATH (as determined by the value of the system property java.class.path). If an entry in the CLASSPATH is a jar file, then JShellLink looks for the native library in the directory containing that jar file. The application can override this behavior and force JShellLink to look for the native library in a specific directory by setting the system property JSHORTCUT_HOME to point to that directory. This property must be set before the JShellLink class is loaded. This makes it possible to use this library from a self-extracting jar file.

Constructor Summary

Constructors

Constructor and Description
JShellLink() Create a JShellLink object with no values filled in.
JShellLink(java.lang.String folder, java.lang.String name) Create a JShellLink object for a specified location.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArguments()
java.lang.String	getDescription()
static java.lang.String	getDirectory(java.lang.String dirtype) Get the requested directory.
java.lang.String	getFolder()
int	getIconIndex()
java.lang.String	getIconLocation()
java.lang.String	getName()
java.lang.String	getPath()
java.lang.String	getWorkingDirectory()
void	load() Load a shortcut from disk.
static void	main(java.lang.String[] argv)
void	save() Write out this shortcut to disk.
void	setArguments(java.lang.String arguments) Set the arguments for this shortcut.
void	setDescription(java.lang.String description) Set the description for this shortcut.
void	setIconIndex(int iconIndex) Set the icon index for this shortcut.
void	setIconLocation(java.lang.String iconLocation) Set the icon location for this shortcut.
void	setPath(java.lang.String path) Set the path for this shortcut.
void	setWorkingDirectory(java.lang.String workingDirectory) Set the working directory for this shortcut.

Methods inherited from class java.lang.Object

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

Constructor Detail

JShellLink

public JShellLink()

Create a JShellLink object with no values filled in.

JShellLink

public JShellLink(java.lang.String folder,
                  java.lang.String name)

Create a JShellLink object for a specified location.

Parameters:

folder - folder where shortcut will be placed

name - filename for the shortcut as seen in windows explore

Method Detail

getDirectory

public static java.lang.String getDirectory(java.lang.String dirtype)

Get the requested directory.

Parameters:

dirtype - One of the following special strings:

• common_desktopdirectory - the All Users desktop folder (not on earlier Windows)
• common_programs - the All Users programs (not on earlier Windows)
• desktop - the Desktop
• personal - the My Documents folder
• programs - the Start Menu/Programs folder
• program_files - the Program Files folder

Returns:

The location of the special folder.

getFolder

public java.lang.String getFolder()

Returns:

the folder for this shortcut.

getName

public java.lang.String getName()

Returns:

the base name for this shortcut.

setDescription

public void setDescription(java.lang.String description)

Set the description for this shortcut.

Parameters:

description - tooltag for the icon

getDescription

public java.lang.String getDescription()

Returns:

the description for this shortcut.

setPath

public void setPath(java.lang.String path)

Set the path for this shortcut. If the working directory is null, this call also sets the working directory to the parent of the given path.

Parameters:

path - set the location where the shortcut looks for an executable

getPath

public java.lang.String getPath()

Returns:

the path for this shortcut.

setArguments

public void setArguments(java.lang.String arguments)

Set the arguments for this shortcut.

Parameters:

arguments - Set the string argument to pass to executable

getArguments

public java.lang.String getArguments()

Returns:

the arguments for this shortcut.

setWorkingDirectory

public void setWorkingDirectory(java.lang.String workingDirectory)

Set the working directory for this shortcut.

Parameters:

workingDirectory - the new working directory

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Returns:

the working directory for this shortcut.

setIconLocation

public void setIconLocation(java.lang.String iconLocation)

Set the icon location for this shortcut.

Parameters:

iconLocation - the new icon directory

getIconLocation

public java.lang.String getIconLocation()

Returns:

the icon location for this shortcut.

setIconIndex

public void setIconIndex(int iconIndex)

Set the icon index for this shortcut.

Parameters:

iconIndex - which icon in the .ico file to use (usually 1)

getIconIndex

public int getIconIndex()

Returns:

the icon index for this shortcut.

load

public void load()

Load a shortcut from disk.

save

public void save()

Write out this shortcut to disk.

main

public static void main(java.lang.String[] argv)