Package com.jidesoft.icons
Class IconSet
- java.lang.Object
-
- com.jidesoft.icons.IconSet
-
public class IconSet extends java.lang.Object
IconSet
is a class which works with JIDE Basic Icon Set (http://www.jidesoft.com/icon/). It defines 141 icons in 12 sections in this class. We could add more in the future. All JIDE icon set will follow the naming conversion as defined here.- See Also:
IconSetManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IconSet.Direction
static class
IconSet.Edit
static class
IconSet.File
static class
IconSet.FindReplace
static class
IconSet.Hardware
static class
IconSet.Help
static class
IconSet.MediaControl
static class
IconSet.Movement
static class
IconSet.Overlay
static class
IconSet.Software
static class
IconSet.Text
static class
IconSet.View
-
Constructor Summary
Constructors Constructor Description IconSet(java.lang.String iconSetName, int[] availableSizes, java.lang.String packageName)
Creates an IconSet.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int[]
getAvailableSizes()
Gets all the available sizes.java.lang.String
getIconSetName()
Gets the icon set name.int
getNextAvailableSize(int size)
Gets the next available size of the requested size.java.lang.String
getPackageName()
Gets the package name.
-
-
-
Constructor Detail
-
IconSet
public IconSet(java.lang.String iconSetName, int[] availableSizes, java.lang.String packageName)
Creates an IconSet.- Parameters:
iconSetName
- the icon set nameavailableSizes
- all available sizes. It must be in order from the smallest to the biggest.packageName
- the package name where the icons exist. All icons in JIDE icon set are defined under "com.jidesoft.icons.". Then under this package, there are subfolders for each icon size.
-
-
Method Detail
-
getIconSetName
public java.lang.String getIconSetName()
Gets the icon set name.- Returns:
- the icon set name.
-
getNextAvailableSize
public int getNextAvailableSize(int size)
Gets the next available size of the requested size. If the size is available in the icon set, it will be returned. Otherwise, the next size that is bigger than the requested size will be returned. For example, if there are 16, 24, 32, 48, 64 size available. If the requested size is 12, 16 will be returned. If 24 is requested, 24 will be returned. If 60 is requested, 64 will be returned. If 128 is requested and it is not available, so 64 will be returned.- Parameters:
size
- the requested size- Returns:
- the next available size.
-
getAvailableSizes
public int[] getAvailableSizes()
Gets all the available sizes.- Returns:
- all the available sizes.
-
getPackageName
public java.lang.String getPackageName()
Gets the package name.- Returns:
- the package name.
-
-