Page tree
Skip to end of metadata
Go to start of metadata

API Klassen und deren Funktionen können nur mit der TecArt-System Version >= 3.2 genutzt werden

1. Methods

1.1. addJavaScript

Syntax:

void addJavascript( string $script )

Beschreibung:

$script enthält JavaScript-Anweisungen, die im Kontext des Grids ausgeführt werden,

1.2. addMenuItemOpen

Syntax:

void addMenuItemOpen( string $action )

Beschreibung:

Fügt dem Kontext-Menü eine Funktion zum Öffnen hinzu. $action enhält JavaScript-Anweisungen, die beim Klick ausgeführt werden.

1.3. getOutput

Syntax:

string getOutput()

Beschreibung:

Gibt den Quellcode der fertigen Grid-Ansicht zurück. Dieser Quellcode kann direkt im Browser gerendert werden.

1.4. getUpdateOutput

Syntax:

string getUpdateOutput()

Beschreibung:

Gibt die Ajax-Response zurück, welche benötigt wird, um die Grid-Ansicht zu aktualisieren.

1.5. setAddMenuItemExport

Syntax:

void setAddMenuItemExport( bool $export )

Beschreibung:

Fügt dem Kontext-Menü einen Eintrag zum Exportieren des Grids hinzu.

1.6. setAddMenuItemPrint

Syntax:

void setAddMenuItemPrint( bool $export )

Beschreibung:

Fügt dem Kontext-Menü einen Eintrag zum Drucken des Grids hinzu.

1.7. setAddMenuItemRefresh

Syntax:

void setAddMenuItemPrint( bool $export )

Beschreibung:

Fügt dem Kontext-Menü einen Eintrag zum Aktualisieren des Grids hinzu.

1.8. setAjaxRefreshAction

Syntax:

void setAjaxRefreshAction( string $action )

Beschreibung:

1.9. setCellFormat

Syntax:

void setCellFormat( array $cellformat )

Beschreibung:

Setzt die Formatangaben für die einzelnen Spalten. Die Länge von $cellformat muss der Anzahl an Spalten entsprechen.

Mögliche Werte sind num (für Zahlen) und str (für Text).

1.10. setColNames

Syntax:

void setColNames( array $names )

Beschreibung:

Setzt die Spaltentitel für die einzelnen Spalten. Die Länge von $names muss der Anzahl an Spalten entsprechen.

Es sind nur Zeichenketten möglich.

1.11. setName

Syntax:

void setName( string $grid_name )

Beschreibung:

Setzt den internen Namen des Grids. Dieser wird vor allem benötigt, um Spaltenbreiten zu speichern.

$grid_name muss eine Zeichenkette sein.

1.12. setRowColors

Syntax:

void setRowColors( array $colors )

Beschreibung:

Setzt die Farben der einzelnen Zeilen des Grids. Die Länge von $colors muss der Zahl der Zeilen entsprechen.

Jedes Element enthält eine Zeichenkette mit dem Aufbau bg_color.':'.font_color.':'.font_weight.':'.border_bottom.':'.border_top

Dabei enthalten die einzelnen Teile folgende Informationen

bg_color        HTML-Farbwert für den Hintergrund
font_color      HTML-farbwert für den Text
font_weight     Schriftstärke (z.B. bold)
border-bottom   CSS-Angabe für die Unterkante der Zeile
border-top      CSS-Angabe für die Oberkante der Zeile

1.13. setSortData

Syntax:

void setSortData( array $sort_data )

Beschreibung:

Setzt die Sortierdaten für das Grid.

Die Länge von $sort_data muss der Zahl der Zeilen des Grids entsprechen. Jeder Eintrag muss aus einem Array bestehen, dessen Länge der Zahl der Spalten entspricht.

1.14. setTabAlign

Syntax:

void setTabAlign( array $aligns )

Beschreibung:

Setzt die Ausrichtungen für die einzelnen Spalten. Die Länge von $aligns muss der Anzahl an Spalten entsprechen.

Mögliche Werte sind left (linksbündig), right (rechtsbündig) und center (zentriert).

1.15. setTabData

Syntax:

void setTabData( array $data )

Beschreibung:

Setzt die Anzeigedaten für das Grid.

Die Länge von $data entspricht dabei der Zahl der Zeilen des Grids. Jeder Eintrag muss aus einem Array bestehen, dessen Länge der Zahl der Spalten entspricht.

1.16. setTabFields

Syntax:

void setTabFields( array $fields )

Beschreibung:

Setzt die Datenfelder für die einzelnen Spalten. Die Länge von $names muss der Anzahl an Spalten entsprechen.

Es sind nur Zeichenketten möglich. Die Spaltenfelder werden benötigt, um den Ajax-Refresh korrekt durchführen zu können.

1.17. setTabIndex

Syntax:

void setTabIndex( array $index )

1.18. setTabSizes

Syntax:

void setTabSizes( array $sizes )

Beschreibung:

Setzt die Breiten für die einzelnen Spalten. Die Länge von $sizes muss der Anzahl an Spalten entsprechen.

Es sind nur Zahlen möglich. Diese Breite der Spalte entspricht der Anzahl px.


  • No labels