Package org.fife.ui.rtextarea
Class IconGroup
java.lang.Object
org.fife.ui.rtextarea.IconGroup
This class encapsulates the location, properties, etc. of an icon set used
for an instance of
RTextArea
. If the location of the icon
group is invalid in any way, any attempt to retrieve icons from an icon
group will return null
.
An icon group can logically refer to any set of icons. You will primarily fetch
icons via the getIcon(String)
method, which fetches an icon at the
specified path from the icon group's jar.
However, to support embedding RSTA in applications that are code editors, icon
groups also support defining icons for file types that RSTA supports, as defined
in SyntaxConstants
. To use this feature,
have your icon group have icons in a fileTypes/
subpath. The icon names
should be the second "part" of the syntax constant values. For example:
- fileTypes/default.png
- fileTypes/java.png
- fileTypes/javascript.png
getFileTypeIcon(String)
is shorthand for
getIcon("fileTypes/" + fileTypePart)
. The only added benefit to
using getFileTypeIcon()
is that method will default to the icon
named "fileTypes/default.<extension>"
if the actually-requested
icon does not exist.- Version:
- 0.5
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates an icon set without "large versions" of the icons.Constructor.Constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether two icon groups are equal.getFileTypeIcon
(String rstaSyntax) Returns an icon that represents the file type specified.Returns the icon from this icon group with the specified name.protected Icon
getIconImpl
(String iconFullPath) Does the dirty work of loading an image.getLargeIcon
(String name) Returns the large icon from this icon group with the specified name.getName()
Returns the name of this icon group.int
hashCode()
boolean
Returns whether a separate directory for the large icons exists.
-
Field Details
-
path
-
separateLargeIcons
private boolean separateLargeIcons -
largeIconSubDir
-
extension
-
name
-
jarFile
-
DEFAULT_EXTENSION
- See Also:
-
-
Constructor Details
-
IconGroup
Creates an icon set without "large versions" of the icons.- Parameters:
name
- The name of the icon group.path
- The directory containing the icon group.
-
IconGroup
Constructor.- Parameters:
name
- The name of the icon group.path
- The directory containing the icon group.largeIconSubDir
- The subdirectory containing "large versions" of the icons. If no subdirectory exists, pass innull
.
-
IconGroup
Constructor.- Parameters:
name
- The name of the icon group.path
- The directory containing the icon group.largeIconSubDir
- The subdirectory containing "large versions" of the icons. If no subdirectory exists, pass innull
.extension
- The extension of the icons (one ofgif
,jpg
, orpng
).
-
IconGroup
Constructor.- Parameters:
name
- The name of the icon group.path
- The directory containing the icon group.largeIconSubDir
- The subdirectory containing "large versions" of the icons. If no subdirectory exists, pass innull
.extension
- The extension of the icons (one ofgif
,jpg
, orpng
).jar
- The Jar file containing the icons, ornull
if the icons are on the local file system. If a Jar is specified, the value ofpath
must be a path in the Jar file. If this is not a valid Jar file, then no Jar file will be used, meaning all icons returned from this icon group will benull
.
-
-
Method Details
-
equals
Returns whether two icon groups are equal. -
getFileTypeIcon
Returns an icon that represents the file type specified.- Parameters:
rstaSyntax
- The syntax value, fromSyntaxConstants
.- Returns:
- The icon, or
null
if a fallback icon should be used.
-
getIcon
Returns the icon from this icon group with the specified name.- Parameters:
name
- The name of the icon. For example, if you want the icon specified innew.gif
, this value should benew
.- Returns:
- The icon, or
null
if it could not be found or loaded. - See Also:
-
getIconImpl
Does the dirty work of loading an image.This method is protected so applications can provide other implementations, for example, adding the ability to load SVG icons.
- Parameters:
iconFullPath
- The full path to the icon, either on the local file system or in the Jar file, if this icon group represents icons in a Jar file.- Returns:
- The icon.
-
getLargeIcon
Returns the large icon from this icon group with the specified name. If this icon group does not have large icons,null
is returned.- Parameters:
name
- The name of the icon. For example, if you want the icon specified innew.gif
, this value should benew
.- Returns:
- The icon, or
null
if it could not be found or loaded. - See Also:
-
getName
Returns the name of this icon group.- Returns:
- This icon group's name.
-
hasSeparateLargeIcons
public boolean hasSeparateLargeIcons()Returns whether a separate directory for the large icons exists.- Returns:
- Whether a directory containing "large versions" of the icons exists.
- See Also:
-
hashCode
public int hashCode()
-