public static class SystemMap.SystemMapElement extends java.lang.Object implements java.io.Serializable, java.lang.Comparable<SystemMap.SystemMapElement>
After creating the element, the module can add StatusItems to it. Several convenience functions are provided for the most common types of status, such as the number of "connected objects".
Modifier and Type | Class and Description |
---|---|
static class |
SystemMap.SystemMapElement.StatusItem
A textual status item to be displayed inside a SystemMapElement.
|
static class |
SystemMap.SystemMapElement.StatusItemState |
Constructor and Description |
---|
SystemMapElement(int order,
java.lang.String titleKey,
java.lang.String statusPanelLink) |
SystemMapElement(int order,
java.lang.String titleKey,
java.lang.String statusPanelLink,
boolean linkExternal) |
Modifier and Type | Method and Description |
---|---|
void |
addNumConnectedStatusItem(int numConnected,
int total)
Adds a status item like: "%d/%d connected" that has a warning state if numConnected is less than total.
|
void |
addNumOpenStatusItem(int numOpen)
Adds a status item like: "%d open".
|
void |
addStatusItem(java.lang.String display,
SystemMap.SystemMapElement.StatusItemState state) |
void |
addStatusItem(SystemMap.SystemMapElement.StatusItem statusItem) |
void |
addStatusItemf(SystemMap.SystemMapElement.StatusItemState state,
java.lang.String bundleKey,
java.lang.Object... args) |
int |
compareTo(SystemMap.SystemMapElement other) |
byte[] |
getActiveIcon() |
byte[] |
getInactiveIcon() |
java.util.List<SystemMap.SystemMapElement.StatusItem> |
getStatusItems() |
java.lang.String |
getStatusPanelLink() |
java.lang.String |
getTitle() |
boolean |
isActive() |
boolean |
isIconVisible() |
boolean |
isLinkExternal() |
void |
setActive(boolean active) |
void |
setActiveIcon(byte[] activeIcon) |
void |
setIcons(java.lang.Class<?> relativeTo,
java.lang.String pathPattern)
Shortcut for setting the active and inactive icons, assuming they are accessible through the classloader
relative to the given class.
|
void |
setIconVisible(boolean iconVisible) |
void |
setInactiveIcon(byte[] inactiveIcon) |
public SystemMapElement(int order, java.lang.String titleKey, java.lang.String statusPanelLink)
public SystemMapElement(int order, java.lang.String titleKey, java.lang.String statusPanelLink, boolean linkExternal)
public void addNumConnectedStatusItem(int numConnected, int total)
public void addNumOpenStatusItem(int numOpen)
public void addStatusItemf(SystemMap.SystemMapElement.StatusItemState state, java.lang.String bundleKey, java.lang.Object... args)
public void addStatusItem(java.lang.String display, SystemMap.SystemMapElement.StatusItemState state)
public void addStatusItem(SystemMap.SystemMapElement.StatusItem statusItem)
public java.util.List<SystemMap.SystemMapElement.StatusItem> getStatusItems()
public int compareTo(SystemMap.SystemMapElement other)
compareTo
in interface java.lang.Comparable<SystemMap.SystemMapElement>
public java.lang.String getTitle()
public java.lang.String getStatusPanelLink()
public boolean isLinkExternal()
public boolean isActive()
public void setActive(boolean active)
public byte[] getActiveIcon()
public void setActiveIcon(byte[] activeIcon)
public byte[] getInactiveIcon()
public void setInactiveIcon(byte[] inactiveIcon)
public void setIcons(java.lang.Class<?> relativeTo, java.lang.String pathPattern) throws java.io.IOException
element.setIcons(getClass(), "images/elmicon_%s.png");
Somewhat cheesy, but effective!
java.io.IOException
- when unable to read from the input streams
obtained from class.getResourceAsStream()java.lang.NullPointerException
- if one of the icons is not found.public boolean isIconVisible()
public void setIconVisible(boolean iconVisible)