Package de.elo.client.scripting.dialog

Class Button

  • Direct Known Subclasses:
    RadioButton, ToggleButton
    public class Button
extends Object

    Überschrift: Button

    Beschreibung: Ein Button zur Verwendung im GridDialog des Internen Scripting.

    Copyright: Copyright (c) ELO Digital Office GmbH 2010-2014

    • Constructor Summary

      Constructors 
      Constructor Description
      Button​(Workspace workspace, AbstractButton button, String eventName)
      Normaler Konstruktor.
      Button​(Workspace workspace, AbstractButton button, BaseFunction callbackFunction, ScriptableObject thisScope)
      Normaler Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      String getText()
      Liefert den angezeigten Button-Text zurück.
      void setBold​(boolean bold)
      Setzt die Schrift in fett.
      void setColor​(int red, int green, int blue)
      Setzt die Schriftfarbe als RGB (jeweils Wertebereich 0 bis 255).
      void setEnabled​(boolean enabled)
      Legt fest, ob der Button aktiv ist.
      void setIcon​(ArchiveDocument iconDocument)
      Setzt ein Icon für den Button.
      void setText​(String value)
      Setzt den angegebenen Button-Text.
      void setTooltip​(String text)
      Setzt einen Hilfe-Tooltip-Text für den Button.
      void setVisible​(boolean visible)
      Setzt die Sichtbarkeit des Buttons.

      • Methods inherited from class Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Button

        public Button​(Workspace workspace,
              AbstractButton button,
              String eventName)
        Normaler Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich
        button - Swing-Button
        eventName - Event-Bezeichnung

      • Button

        public Button​(Workspace workspace,
              AbstractButton button,
              BaseFunction callbackFunction,
              ScriptableObject thisScope)
        Normaler Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich
        button - Swing-Button
        callbackFunction - JavaScript Funktion
        thisScope - "this" Scope der Funktion
        Since:
        10.00.000

    • Method Detail

      • setText

        public void setText​(String value)
        Setzt den angegebenen Button-Text.
        Parameters:
        value - Button-Text
        Since:
        7.00.004

      • getText

        public String getText()
        Liefert den angezeigten Button-Text zurück.
        Returns:
        Text des Buttons
        Since:
        7.00.004

      • setColor

        public void setColor​(int red,
                     int green,
                     int blue)
        Setzt die Schriftfarbe als RGB (jeweils Wertebereich 0 bis 255).
        Parameters:
        red - Rot-Wert der Farbe
        green - Grün-Wert der Farbe
        blue - Blau-Wert der Farbe
        Since:
        7.00.004

      • setBold

        public void setBold​(boolean bold)
        Setzt die Schrift in fett.
        Parameters:
        bold - True bedeutet Schriftart in fett, False bedeutet eine normale Schriftart
        Since:
        7.00.004

      • setEnabled

        public void setEnabled​(boolean enabled)
        Legt fest, ob der Button aktiv ist.
        Parameters:
        enabled - True wenn der Button aktiv sein soll
        Since:
        7.00.008

      • setIcon

        public void setIcon​(ArchiveDocument iconDocument)
             throws Exception
        Setzt ein Icon für den Button. Das Icon muss ein PNG in der Größe 24x24 Pixel mit Alphatransparenz sein.
        Parameters:
        iconDocument - Archiveintrag des Icons
        Throws:
        Exception - Wenn das Icon nicht geladen werden kann.
        Since:
        8.01.000, 9.02.000 Unterstützung von ICO Dateien. Der erste Layer gibt die größe bei 96 DPI an.

      • setTooltip

        public void setTooltip​(String text)
        Setzt einen Hilfe-Tooltip-Text für den Button.
        Parameters:
        text - Hilfe-Text
        Since:
        8.01.000

      • setVisible

        public void setVisible​(boolean visible)
        Setzt die Sichtbarkeit des Buttons.
        Parameters:
        visible - True für sichtbar, False für unsichtbar.
        Since:
        8.01.006