Package de.willuhn.jameica.gui.input

Interface Input

All Superinterfaces:
Part
All Known Implementing Classes:
AbstractInput, ButtonInput, CheckboxInput, ColorInput, DateInput, DecimalInput, DialogInput, DirectoryInput, FileInput, FontInput, ImageInput, IntegerInput, LabelInput, LinkInput, MultiInput, PasswordInput, PluginInput, QueryInput, RadioInput, ReminderIntervalInput, ScaleInput, SearchInput, SelectInput, ShortcutInput, SpinnerInput, TextAreaInput, TextInput
public interface Input extends Part
Basis-Interface fuer alle Eingabefelder in Jameica.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DATAKEY_TOOLTIP
    Key fuer die Context-Information mit dem Tooltip.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(org.eclipse.swt.widgets.Listener l)
    Fuegt dem Eingabe-Feld einen Listener hinzu, der bei jedem Focus-Wechsel ausgeloest wird.
    void
    disable()
    Deaktiviert das Eingabefeld.
    void
    enable()
    Aktiviert das Eingabefeld.
    void
    focus()
    Gibt diesem Eingabefeld den Focus.
    org.eclipse.swt.widgets.Control
    getControl()
    Liefert das eigentliche Eingabecontrol.
    Object
    getData(String key)
    Liefert die Context-Daten.
    String
    getName()
    Liefert die Label-Bezeichnung des Eingabe-Feldes.
    Object
    getValue()
    Liefert den Wert des Eingabefelds.
    boolean
    hasChanged()
    Prueft, ob sich der Wert von getValue() seit dem letzten Aufruf von hasChanged() geaendert hat.
    boolean
    isEnabled()
    Prueft, ob das Eingabe-Feld aktiv ist.
    boolean
    isMandatory()
    Prueft, ob es sich um ein Pflichtfeld handelt.
    void
    paint(org.eclipse.swt.widgets.Composite parent)
    Positioniert und malt das Eingabefeld im uebergebenen Composite.
    void
    paint(org.eclipse.swt.widgets.Composite parent, int width)
    Positioniert und malt das Eingabefeld im uebergebenen Composite.
    void
    setComment(String comment)
    Fuegt hinter das Eingabefeld noch einen Kommentar.
    void
    setData(String key, Object data)
    Speichert optionale Context-Daten.
    void
    setEnabled(boolean enabled)
    Aktiviert oder deaktiviert das Eingabe-Feld.
    void
    setMandatory(boolean mandatory)
    Legt fest, ob es sich um ein Pflichtfeld handelt.
    void
    setName(String name)
    Speichert die Label-Bezeichnung des Eingabe-Feldes.
    void
    setValue(Object value)
    Schreibt einen neuen Wert in das Eingabefeld.

  • Field Details

    • DATAKEY_TOOLTIP

      static final String DATAKEY_TOOLTIP
      Key fuer die Context-Information mit dem Tooltip.
      See Also:

  • Method Details

    • getValue

      Object getValue()
      Liefert den Wert des Eingabefelds.
      Returns:
      Wert des Feldes.

    • setValue

      void setValue(Object value)
      Schreibt einen neuen Wert in das Eingabefeld.
      Parameters:
      value - der neu anzuzeigende Wert.

    • hasChanged

      boolean hasChanged()
      Prueft, ob sich der Wert von getValue() seit dem letzten Aufruf von hasChanged() geaendert hat.
      Returns:
      true, wenn sich der Wert geaendert hat, sonst false.

    • getControl

      org.eclipse.swt.widgets.Control getControl()
      Liefert das eigentliche Eingabecontrol. Es muss von jeder abgeleiteten Klasse implementiert werden und das Eingabe-Feld zurueckliefern.

      Da der Implementierer das Composite benoetigt, in dem das Control positioniert werden soll, kann er sich der Methode AbstractInput.getParent() in dieser Klasse bedienen.

      Returns:
      das zu zeichnende Control.

    • addListener

      void addListener(org.eclipse.swt.widgets.Listener l)
      Fuegt dem Eingabe-Feld einen Listener hinzu, der bei jedem Focus-Wechsel ausgeloest wird. Besteht das Eingabe-Feld aus mehreren Teilen (z.Bsp. bei SearchInput aus Eingabe-Feld + Knopf dahinter) dann wird der Listener bei Focus-Wechsel jedes dieser Teile ausgeloest.
      Parameters:
      l - zu registrierender Listener.

    • setComment

      void setComment(String comment)
      Fuegt hinter das Eingabefeld noch einen Kommentar. Existiert der Kommentar bereits, wird er gegen den neuen ersetzt.

      Hinweis: Wird die Funktion nicht aufgerufen, bevor das Eingabe-Feld gemalt wird, dann wird es auch nicht angezeigt. Denn vorm Malen muss bekannt sein, ob es angezeigt werden soll, damit der Platz dafuer reserviert werden kann.

      Parameters:
      comment - Kommentar.

    • paint

      void paint(org.eclipse.swt.widgets.Composite parent)
      Positioniert und malt das Eingabefeld im uebergebenen Composite. Es wird dabei mit einer vorgegebenen Standard-Breite gemalt.
      Specified by:
      paint in interface Part
      Parameters:
      parent - Das Composite, in dem das Eingabefeld gemalt werden soll.
      See Also:

    • paint

      void paint(org.eclipse.swt.widgets.Composite parent, int width)
      Positioniert und malt das Eingabefeld im uebergebenen Composite.
      Parameters:
      parent - Das Composite, in dem das Eingabefeld gemalt werden soll.
      width - angegebene Breite.

    • focus

      void focus()
      Gibt diesem Eingabefeld den Focus.

    • disable

      void disable()
      Deaktiviert das Eingabefeld.

    • enable

      void enable()
      Aktiviert das Eingabefeld.

    • setEnabled

      void setEnabled(boolean enabled)
      Aktiviert oder deaktiviert das Eingabe-Feld.
      Parameters:
      enabled - true, wenn es aktiv sein soll.

    • isEnabled

      boolean isEnabled()
      Prueft, ob das Eingabe-Feld aktiv ist.
      Returns:
      true, wenn es aktiv ist.

    • setMandatory

      void setMandatory(boolean mandatory)
      Legt fest, ob es sich um ein Pflichtfeld handelt.
      Parameters:
      mandatory - true, wenn es ein Pflichtfeld ist.

    • isMandatory

      boolean isMandatory()
      Prueft, ob es sich um ein Pflichtfeld handelt.
      Returns:
      true, wenn es sich um ein Pflichfeld handelt.

    • setName

      void setName(String name)
      Speichert die Label-Bezeichnung des Eingabe-Feldes.
      Parameters:
      name - Label-Bezeichnung.

    • getName

      String getName()
      Liefert die Label-Bezeichnung des Eingabe-Feldes.
      Returns:
      Label-Bezeichnung.

    • setData

      void setData(String key, Object data)
      Speichert optionale Context-Daten.
      Parameters:
      key - freier Schluessel.
      data - beliebige Nutzdaten.
      See Also:
      • Widget.setData(Object)

    • getData

      Object getData(String key)
      Liefert die Context-Daten.
      Parameters:
      key - der Schluessel.
      Returns:
      die Contextdaten.