|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bigzip.ResourceLocator
The ResourceLocator is used to load resources (icons, images, help files, etc.) in a way that is independant of location and user preferences.
Field Summary | |
static java.lang.String |
ACTION_ANIMATION_PATH
This is the location of the anaimated version of the standard BiGZiP images. |
static java.lang.String |
ACTION_IMAGE_PATH
This is the location of the standard BiGZiP non-animated images. |
static java.lang.String |
HELP_PATH
This is the standard location for help files. |
static java.lang.String |
IMAGE_PATH
This is the standard location where general images are stored. |
static java.lang.String |
RESOURCE_PATH
This is the standard location where resources are stored. |
Constructor Summary | |
ResourceLocator()
|
Method Summary | |
static com.bigzip.HelpSet |
getHelpSet(java.lang.String helpPathName)
Loads a HelpSet from the file system so that it may be incorperated into BiGZiP's help when a plugin is loaded. |
static javax.swing.ImageIcon |
getSystemIconResource(java.lang.String iconresourcePathName)
Retreives an image icon from the specified system resource. |
static java.net.URL |
getSystemResource(java.lang.String resourcePathName)
Retreives a URL that can access the specified system resource. |
static java.io.InputStream |
getSystemResourceAsStream(java.lang.String resourcePathName)
Retreives a stream containing the specified system resource. |
static javax.swing.ImageIcon |
getUserIconResource(java.lang.String iconresourcePathName)
Retrieves an image icon from an image file in the bigzip directory in the current user's home directory or a subdirectory of the user's bigzip directory. |
static java.io.File |
getUserResource(java.lang.String resourcePathName)
Retrieves File object to access a file in the bigzip directory in the current user's home directory or a subdirectory of the user's bigzip directory. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String RESOURCE_PATH
public static final java.lang.String IMAGE_PATH
public static final java.lang.String ACTION_IMAGE_PATH
public static final java.lang.String ACTION_ANIMATION_PATH
public static final java.lang.String HELP_PATH
Constructor Detail |
public ResourceLocator()
Method Detail |
public static com.bigzip.HelpSet getHelpSet(java.lang.String helpPathName) throws com.bigzip.HelpSetException
helpPathName
- The path to the help file relative to the location
of the com.bigzip package.com.bigzip.HelpSetException
- The path is invalid or doesn't refere to a
help file, or an error occurred while trying
to load the help file.public static java.net.URL getSystemResource(java.lang.String resourcePathName)
resourcePathName
- The path to the system resource relative to
the location of the com.bigzip package.public static java.io.InputStream getSystemResourceAsStream(java.lang.String resourcePathName)
resourcePathName
- The path to the system resource relative to
the location of the com.bigzip package.public static javax.swing.ImageIcon getSystemIconResource(java.lang.String iconresourcePathName)
iconresourcePathName
- The path to the image file relative to
the location of the com.bigzip package.public static java.io.File getUserResource(java.lang.String resourcePathName)
resourcePathName
- The path of the resource relative to the
user's home directory.public static javax.swing.ImageIcon getUserIconResource(java.lang.String iconresourcePathName)
iconresourcePathName
- The path of the image file relative to the
user's home directory.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |