Package de.willuhn.jameica.gui.boxes
Interface Box
-
- All Superinterfaces:
java.lang.Comparable
,Part
- All Known Implementing Classes:
AbstractBox
,FirstStart
,OnlineUpdates
,PluginErrors
,PluginRepositories
,SystemMessages
public interface Box extends Part, java.lang.Comparable
Eine Box ist eine GUI-Komponente, die auf der Welcome-Page von Hibiscus angezeigt und vom User frei angeordnet werden koennen. Implementierende Klassen muessen einen parameterlosen Konstruktor mit dem Modifier public besitzen, damit sie vom Classloader zur Laufzeit geladen werden koennen.
-
-
Field Summary
Fields Modifier and Type Field Description static int
HEIGHT_DEFAULT
Platzhalter fuer Default-Hoehe.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getDefaultEnabled()
Liefert den Default-Wert fuer die Aktivierung der Box.int
getDefaultIndex()
Liefert die Positon der "Werkseinstellungen".int
getHeight()
Liefert die Hoehe, die fuer die Box standardmaessig eingeplant werden soll.int
getIndex()
Liefert die Position, an der die Box angezeigt werden soll.java.lang.String
getName()
Liefert den Namen der Box.boolean
isActive()
Prueft, ob die Box dem User ueberhaupt zur Auswahl geboten werden soll.boolean
isEnabled()
Prueft, ob die Box angezeigt werden soll.void
setEnabled(boolean enabled)
Aktiviert/Deaktiviert die Box.void
setIndex(int index)
Speichert die Position der Box.
-
-
-
Field Detail
-
HEIGHT_DEFAULT
static final int HEIGHT_DEFAULT
Platzhalter fuer Default-Hoehe.- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
Liefert den Namen der Box.- Returns:
- Name der Box.
-
isEnabled
boolean isEnabled()
Prueft, ob die Box angezeigt werden soll.- Returns:
- true, wenn sie angezeigt werden soll.
-
setEnabled
void setEnabled(boolean enabled)
Aktiviert/Deaktiviert die Box.- Parameters:
enabled
-
-
getDefaultEnabled
boolean getDefaultEnabled()
Liefert den Default-Wert fuer die Aktivierung der Box.- Returns:
- Default-Wert.
-
getIndex
int getIndex()
Liefert die Position, an der die Box angezeigt werden soll.- Returns:
- die Position.
-
setIndex
void setIndex(int index)
Speichert die Position der Box.- Parameters:
index
- die Position.
-
getDefaultIndex
int getDefaultIndex()
Liefert die Positon der "Werkseinstellungen".- Returns:
- Default-Index.
-
isActive
boolean isActive()
Prueft, ob die Box dem User ueberhaupt zur Auswahl geboten werden soll.- Returns:
- true, wenn sie zur Auswahl stehen soll.
-
getHeight
int getHeight()
Liefert die Hoehe, die fuer die Box standardmaessig eingeplant werden soll.- Returns:
- Hoehe der Box oder "-1", wenn keine Hoehe explizit angegeben werden soll.
-
-