Custom Renderer

value

Das ist die eigentliche Custom Renderer Methode. Darin wird angegeben, was in der Zelle angezeigt wird.

Ein Custom Renderer ohne value bzw. get_value() zeigt nichts an. Dieser Wert bzw. diese Methode muss also immer gesetzt werden.

def get_value(self, rowobj, expression, subscriber):
    return self.evalocl(expression, rowobj)

Ist die Zelle beschreibbar, wird der vom User eingegebene Wert mit dieser Methode geschrieben.

def set_value(self, rowobj, expression, value):
    setattr(rowobj, expression, value)

Es muss sichergestellt sein, dass der übergebene Wert den gewünschten Typ hat. Standardmässig ist value ein String-Wert. Bei allen Datentypen, die nicht als String geschrieben werden können, muss ein passendes Steuerelement (display_type) verwendet oder der value_type entsprechend gesetzt wird (siehe unten).

Wichtiger Hinweis:

Keine Dialoge oder anderer Code mit Haltepunkten nach dem Ändern von Werten, die in einer get-Methode eine Subscription auslösen:

In einer set-Methode werden Daten verändert. Wird dadurch eine Subscription getriggert, wird die Liste neu berechnet. Dabei werden auch alle bestehenden Renderer neu geladen. Zeigt man nun in der set-Methode einen Dialog oder stoppt den Code anderswie, gilt der Änderungsvorgang technisch als abgeschlossen, und durch die Subscription wird die Liste neu berechnet. Damit wird auch der Renderer, der den Dialog anzeigt, entfernt, was zu einem Fehler führt: Ein COM-Objekt, das vom zugrunde liegenden RCW getrennt wurde, kann nicht verwendet werden..

value_type

Erlaubt es, den erwarteten Datentyp für den Custom Renderer anzugeben.

Die set_value Methode (siehe oben) erhält dann als Argument einen Wert des angegebenen Typs und bei der get_value Methode wird erwartet, dass dieser Typ zurückgegeben wird.

Folgende Werte sind erlaubt:

• integer: Ganzzahlen
• currency: Währungen
• float: Festkommazahlen
• date: Datumswerte
• datetime: Datums- und Zeitwerte
• boolean: Wahr/Falsch Werte
• string: Zeichenketten
• blob: Langer Text (und Bilder)

Anwendungsbeispiel: Ein Custom Renderer arbeitet mit Stundensätzen (currency). Damit die set_value Methode einen Currency-Wert erhält, muss die get_value_type Methode definiert bzw. der value_type auf currency gesetzt werden:

class Ansatz:
    value_type = "currency"
    def get_value(self, rowobj, expression, subscriber):
        return self.evalocl(expression, rowobj)            
    def set_value(self, rowobj, expression, value):
        setattr(rowobj, expression, value)

Wichtiger Hinweis:

• Bei boolean Werten muss zusätzlich der display_type checkbox gewählt werden (siehe unten).
• Bei blob-Feldern muss es sich um langen Text handeln. Bilder können nicht in Listenzellen dargestellt werden, nur Icons (siehe display_type icon unten).
• Die Renderer funktionieren nicht mit Objektreferenzen.

display_type

get_display_type(self)

Die get_display_type Methode wird pro Spalte ausgewertet, daher werden rowobj, expression und subscriber Objekte nicht mitgeliefert.

Zugelassene Werte sind:

• checkbox: Die Spalte stellt eine Checkbox dar. Als value_type muss 'boolean' angegeben werden. Die entsprechenden get_value und set_value Methoden verarbeiten dann boolean-Werte.

class Aktiv:
    display_type = 'checkbox'
    value_type = 'boolean'
    def get_value(self, rowobj, expression, subscriber):
        return self.evalocl('aktiv', rowobj)
    def set_value(self, rowobj, expression, value):
        rowobj.aktiv = value

• icon: Die Spalte wird als Icon dargestellt. Die get_value Funktion muss dazu einen Integer (Icon Index) oder String (Icon Name) zurückgeben.

  class Icon:
      display_type = 'icon'
      def get_value(self, rowobj, expression, subscriber):
          return self.evalocl('iconindex', rowobj)

• button: Die Zelle zeigt einen Action Button an. Mit der get_value Methode wird eruiert, was als Buttontext angezeigt wird.
  Zusätzlich kann auch ein Icon hinzugefügt werden, indem die buttoniconid gesetzt bzw. die get_buttoniconid Methode aufgerufen wird. Diese muss einen Integer (Icon Index) oder String (Icon Name) zurückgeben.
  Hinweis: In Seiteneinstellungen werden Icons auf den Buttons nicht dargestellt, nur in der Liste.
  • Mit der button_clicked Methode kann definiert werden, was ablaufen soll, wenn der User auf den Button klickt.
  • Mit der buttontooltip Methode (ab Version 6.6) kann auf dem Button ein Tooltip angezeigt werden.

 class CopyProjectRenderer:
    display_type = "button"
    def get_value(self, rowobj, expression, subscriber):
        return "Projekt kopieren"
    def get_buttoniconid(self, rowobj, expression, subscriber):
        return self.evalocl('iconIndex', rowobj)        
    def button_clicked(self, rowobj, expression):
        scripttext = self.evalocl("scripteintrag->select(bezeichnung='Projekt kopieren')->first.scripttext")
        return vtcapp.scriptexecute(scripttext, rowobj)

buttoniconid

display_type = "button"
def get_buttoniconid(self, rowobj, expression, subscriber):
    return self.evalocl('iconIndex', rowobj)

Wird kein Icon angegeben, oder gibt es das Icon nicht, dann wird das Icon flash angezeigt.

Ist explizit ein Leerstring "" angegeben, dann wird der Button für diese Zelle ausgeblendet.

display_type = "button"
def button_clicked(self, rowobj, expression):
    return vtcapp.msgbox("Hello World")

Wichtiger Hinweis:

Keine Dialoge oder anderer Code mit Haltepunkten nach dem Ändern von Werten, die in einer get-Methode eine Subscription auslösen:

Werden in einer button_clicked Methode Daten verändert, können dadurch Subscription getriggert und die Liste neu berechnet werden. Dabei werden auch alle bestehenden Renderer neu geladen. Zeigt man nun in nach der Datenänderung noch einen Dialog an oder stoppt den Code anderswie, gilt der Änderungsvorgang technisch als abgeschlossen, und durch die Subscription wird die Liste neu berechnet. Damit wird auch der Renderer, der den Dialog anzeigt, entfernt, was zu einem Fehler führt: Ein COM-Objekt, das vom zugrunde liegenden RCW getrennt wurde, kann nicht verwendet werden.

buttontooltip

Mit der buttontooltip Methode (ab Version 6.6) kann auf dem Button ein Tooltip angezeigt werden.

class simpleBtn:
    display_type='button'
    buttoniconid='flash'
    buttontooltip='Hier ein Tipp'

class complexBtn:
    display_type='button'
    buttoniconid='shark_fin'
    def get_buttontooltip(self,rowObject, expression, subscriber):
        return self.evalocl("bemerkung", rowObject)

converter

get_converter(self)

Die get_converter Methode wird pro Spalte ausgewertet, daher werden rowobj, expression und subscriber Objekte nicht mitgeliefert.

Folgende Converter können verwendet werden:

• minutes: Für integer Werte. Stellt Minutenwerte gemäss Systemeinstellung Anzeige Minuten dar.
• noroundminutes: Für integer Werte. Gleich wie minutes, ignoriert aber die Systemeinstellung Runden Minuten auf.
• rate: Für currency Werte. Für Ansätze, berücksichtigt die Systemeinstellung Stundensätze nicht runden.
• translation: Für string Werte. Der String wird übersetzt gemäss Vertec Übersetzungssystem.

 class Minutes:
    value_type = "integer"
    converter = "minutes"
    def get_value(self, rowobj, expression, subscriber):
        return rowobj.evalocl(expression)
    def set_value(self, rowobj, expression, value):
        setattr(rowobj, expression, value)   

is_readonly

Damit kann gesteuert werden, ob eine Zelle schreibgeschützt ist oder nicht.

Mögliche Werte: True oder False. Standardwert: False.

is_cascadedset

Geübtere Vertec-Nutzer kennen das Verhalten, dass die Schrift grün wird, wenn man gewisse Werte überschreibt, und Schwarz ist, wenn es sich um einen berechneten Wert handelt, zum Beispiel bei der Projektbudgetierung.

So sieht man auf der Oberfläche auf den ersten Blick, ob ein Wert auf dem Objekt selbst gesetzt (also irgend ein Standard überschrieben) wurde, oder ob es sich um den Standardwert handelt.

Mit is_cascadedset bzw. get_is_cascadedset kann das nachgebildet werden:

• Der get_value schaut, ob ein gewisses Feld beschrieben ist, und nimmt ansonsten den Standardwert.
• Der set_value beschreibt das gewisse Feld.
• Das is_cascadedset ist True, wenn das gewisse Feld beschrieben ist.

Mögliche Werte: True (grüne Schrift) oder False (schwarze Schrift). Standardwert: False.

text_color

Damit kann die Schriftfarbe gesteuert werden. Gültig sind alle Werte der Vertec Farbpalette.

Standard: Es greift der Vertec Standard.

background_color

Damit kann die Hintergrundfarbe der Zelle gesteuert werden. Gültig sind alle Werte der Vertec Farbpalette.

Standard: Es greift der Vertec Standard.

self.evalocl(expression, rootobj=None)

Erlaubt das Evaluieren von OCL-Expressions auf dem Objekt.

• expression: Die Spalten- bzw. Feld-Expression
• rootobj: Optional. Hier kann ein beliebiges Vertec Objekt angegeben werden. Falls angegeben, erfolgt die Evaluierung auf diesem Objekt, ansonsten global.

Im OCL Evaluator steht eine Variable varRowObject zur Verfügung. Dies erlaubt den direkten Zugriff auf das aktuelle Zeilen-Objekt in der Liste.

 self.evalocl("varRowObject")

self.container

self.context

self.controller

Ab Vertec 6.6. In Verwendung mit List Controllern die Referenz auf das List Controller Objekt: Wenn in einer Liste mit einem List Controller eine Spalte einen Custom Renderer verwendet, dann erhält der Custom Renderer unter self.controller eine Referenz auf den List Controller. Dies ist für alle Custom Renderer der Liste dasselbe Objekt.
Dadurch können beispielsweise in der initialize() Methode des List Controllers Daten vorberechnet werden, welche anschliessend für alle Custom Renderer der Liste verfügbar sind.

def get_value(self, rowobj, expression, subscriber):
    return self.evalocl("code", rowobj)

def get_value(self, rowobj, expression, subscriber):
    rowobj.subscribetomember("code", subscriber)
    return rowobj.code