Interface Box

All Superinterfaces:
Comparable, Part
All Known Implementing Classes:
AbstractBox, FirstStart, OnlineUpdates, PluginErrors, PluginRepositories, SystemMessages

public interface Box extends Part, 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 final int
    Platzhalter fuer Default-Hoehe.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Liefert den Default-Wert fuer die Aktivierung der Box.
    int
    Liefert die Positon der "Werkseinstellungen".
    int
    Liefert die Hoehe, die fuer die Box standardmaessig eingeplant werden soll.
    int
    Liefert die Position, an der die Box angezeigt werden soll.
    Liefert den Namen der Box.
    boolean
    Prueft, ob die Box dem User ueberhaupt zur Auswahl geboten werden soll.
    boolean
    Prueft, ob die Box angezeigt werden soll.
    void
    setEnabled(boolean enabled)
    Aktiviert/Deaktiviert die Box.
    void
    setIndex(int index)
    Speichert die Position der Box.

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface de.willuhn.jameica.gui.Part

    paint
  • Field Details

    • HEIGHT_DEFAULT

      static final int HEIGHT_DEFAULT
      Platzhalter fuer Default-Hoehe.
      See Also:
  • Method Details

    • getName

      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.