Custom renderer

value

This is the actual custom renderer method. It specifies what is shown in the row.

A custom renderer without value or get_value() does not display anything. Thefore, this value or method must always be set.

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

If the row is writable, the value entered by the user is written using this method.

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

You must make sure that the given value is of the desired type. By default, value is a string value. For all data types that cannot be written as a string, a matching control (display_type) or the value_type is set accordingly (see below).

Important note:

No dialogs or other code with breakpoints after changing values which trigger a subscription  in a get method:

A set method changes data. If this triggers a subscription, the list is recalculated. All existing renderers are also reloaded. If the set method shows a dialog or stops the code in any other way, the modification process is technically completed, and the subscription recalculates the list. This also removes the renderer showing the dialog, which results in an error:You cannot use a COM object that has been separated from the underlying RCW.

value_type

Allows you to specify the expected data type for the custom renderer.

The set_value method (see above) then takes as an argument a value of the specified type and with the get_value method, it is expected to return this type.

The following values are allowed:

• integer: integers
• currency: currencies
• float: fixed point numbers
• date: date values
• datetime: date and time values
• boolean: true/false values
• string: character strings
• blob: long text (and pictures)

Example of application: A custom renderer works with hourly rates (currency). In order for the set_value method to receive a currency value, the get_value_type method must be defined or the value_type must be set to currency:

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)

Important note:

• For boolean values, the display_type checkbox must also be activated (see below).
• Blob fields must be long text. Images cannot be displayed in list rows, only icons (see display_type icon below).
• The renderers do not work with object references.

display_type

get_display_type(self)

The get_display_type method is evaluated per column, so rowobj, expression and subscriber objects are not included.

Permitted values are:

• checkbox: The column represents a checkbox. As value_type 'boolean’ must be specified. The corresponding get_value and set_value methods then process boolean values.

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: The column is displayed as an icon. The get_value function must have an integer (icon index ) or string (icon name ) is returned.

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

• button: The cell displays an action button. The get_value method determines what is shown as the button text. In addition, an icon can be added by setting the buttoniconid  or callling up the get_buttoniconid method. This must return an integer (icon index ) or string (icon name ).
  Note: In page settings, icons are not shown on the buttons, only in the list.
  • With the button_clicked method, you can define what should happen when the user clicks on the button.
  • With the buttontooltip method (from version 6.6), a tooltip can be shown on the button.

 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)

If no icon  is specified or if the icon is not present, then the flash icon is shown.

If an empty string ““ is explicitly specified, the button for this row is hidden.

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

Important note:

No dialogs or other code with breakpoints after changing values that trigger a subscription in a get method:

If data is changed in a button_clicked method, subscription can be triggered and the list recalculated. This will also reload all existing renderers. If you now display a dialog after changing the data or stop the code in any other way, the modification process is technically completed and the subscription recalculates the list. This also removes the renderer showing the dialog, which results in an error: You cannot use a COM object that has been separated from the underlying RCW.

buttontooltip

With the buttontooltip method (from version 6.6), a tooltip can be shown on the button.

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)

The get_converter method is evaluated per column, so rowobj, expression, and subscriber objects are not included.

The following converters can be used:

• minutes: For integer values. Set minute values according to system setting Display minutes .
• noroundminutes: For integer values. Same as minutes, but ignores the system setting Round minutes to .
• rate: For currency values. For rates, considers the system setting Don't round hourly rates .
• translation: For string values. The string is translated according to the Vertec translation system .

 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

This can be used to control whether or not a row is read-only.

Possible values: True or False. Default value: False .

is_cascadedset

More experienced Vertec users are familiar with the behavior that the font turns green when you overwrite certain values and is black when it is a calculated value, for example in project budgeting .

In this way, you can see at first glance on the interface whether a value has been set on the object itself (i.e. a default has been overwritten) or whether it is the default value.

This can be replicated with is_cascadedset or get_is_cascadedset:

• The get_value looks at whether a certain field is described and otherwise takes the default value.
• The set_value describes the particular field.
• The is_cascadedset is True if the particular field is described.

Possible values: True (green font) or False (black font). Default value: False .

text_color

This allows you to control the font color. Valid are all values of the Vertec color palette .

Default: The Vertec default applies.

background_color

This allows you to control the background color of the row. All values in the Vertec color palette are valid.

Default: The Vertec default applies.

self.evalocl(expression, rootobj=None)

Allows OCL expressions to be evaluated on the object.

• expression: The column or field expression
• rootobj: Optional. Any Vertec object can be specified here. If specified, evaluation occurs on this object, otherwise globally.

The OCL evaluator provides a variable varRowObject. This allows direct access to the current row object in the list.

 self.evalocl("varRowObject")

self.container

self.context

self.controller

Available from Vertec 6.6. Used with list controllers which refer to the list controller object: If a column in a list with a list controller uses a custom renderer, then the custom renderer gets a reference to the list controller under self.controller. This is the same
object for all custom renderers in the list. Consequently, data can be precalculated in the initialize() method of the list controller, which is then available for all the list's custom renderers.

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