Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. addField(Object / parameterId) - dodaje pole parametru na ostatniej pozycji
  2. insertField(position, Object / parameterId) - dodaje pole parametru na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition)
  3. removeField(parameterId) - usuwa pole parametru
  4. hideField (parameterId) - ukrywa parametr
  5. showField(parameterId) - pokazuje parametr
  6. focusField(parameterId) - ustawia kursor w polu parametru
  7. addLabel("Label text") - dodaje etykietę na ostatniej pozycji
  8. insertLabel(position, "Label text" ) - dodaje etykietę na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition)
  9. addCheckbox(Object) - dodaje checkbox na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
    1. name - nazwa pola
    2. description - opis pola
  10. insertCheckbox(position, Object) - dodaje checkbox na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition)
  11. addCombobox(Object) - dodale listę rozwijaną na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
    1. id - identyfikator parametru typu String, który będzie w formie listy rozwijanej, jeśli id nie jest podane, parametr nie istnieje lub zmienna jest innego typu, niż string, to do formularza parametrów jest dodawana niezależna lista rozwijana
    2. text - etykieta pola
    3. value - wartość początkowa
    4. remote - informuje, czy dane listy rozwijanej mają być pobierane z serwera, czy jest to statyczna lista (domyślnie: false), gdy remote ma wartość true, to do serwera podczas pobierania danych przekazywane są następujące parametry:
      1. sort - nazwa pola, po którym dane są sortowane
      2. dir - kierunek sortowania (ASC/DESC)
      3. query - aktualnie wpisana wartość w listę rozwijaną, służy do filtrowania wartości
      4. start - offset
      5. limit - rozmiar strony
      Serwer musi zwrócić obiekt json z polami:
      1. total - całkowita liczba wyników,
      2. data - pobrane dane z uwzględnieniem stronnicowania
    5. values - lista wartości dla statycznej listy rozwijanej, właściwość jest tablicą obiektów, z których każdy posiada następujące własności
      1. id - identyfikator wartości
      2. display - nazwa wartości
      3. description - opis wartości
    6. url - url zwracający dane z serwera dla dynamnicznej listy rozwijanej, może być także w postaci funkcji zwracającej wartość typu String, która przyjmuje następujące parametry:
      1. options - dodatkowe parametry przekazywane do funkcji
        1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
    7. fields - pola, jakie są zwracane z serwera, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
      1. name - nazwa pola
      2. type - typ pola (string, boolean, integer, float, date)
    8. valueField - nazwa pola, którego wartość ma być ustawiana jako wartość parametru
    9. displayField - nazwa pola, którego wartość jest wyświetlana na liście
    10. pageSize - rozmiar strony (domyślnie: 20)
    11. template - szablon opisujący sposób wyświetlania wartości na liście, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
      1. label - etykieta dla pola
      2. field - nazwa pola
    12. sort - umozliwia określenie sortowania danych z serwera, właściwość jest obiektem, który posiada następujące własności:
      1. field - nazwa pola, po którym występuje sortowanie
      2. direction - kierunek sortowania (ASC/DESC)
    13. onChange - funkcja wykonywana po wybraniu wartości z listy, przyjmuje następujące parametry:
      1. value - wartość pola parametru
      2. options - dodatkowe parametry przekazywane do funkcji
        1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
  12. insertCombobox(position, Object) - dodale listę rozwijaną na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), obiekt definicji zawiera następujące właściwości:
    1. id - identyfikator parametru typu String, który będzie w formie listy rozwijanej, jeśli id nie jest podane, parametr nie istnieje lub zmienna jest innego typu, niż string, to do formularza parametrów jest dodawana niezależna lista rozwijana
    2. remote - informuje, czy dane listy rozwijanej mają być pobierane z serwera, czy jest to statyczna lista (domyślnie: false), gdy remote ma wartość true, to do serwera podczas pobierania danych przekazywane są następujące parametry:
      1. sort - nazwa pola, po którym dane są sortowane
      2. dir - kierunek sortowania (ASC/DESC)
      3. query - aktualnie wpisana wartość w listę rozwijaną, służy do filtrowania wartości
      4. start - offset
      5. limit - rozmiar strony
      Serwer musi zwrócić obiekt json z polami:
      1. total - całkowita liczba wyników,
      2. data - pobrane dane z uwzględnieniem stronnicowania
    3. values - lista wartości dla statycznej listy rozwijanej, właściwość jest tablicą obiektów, z których każdy posiada następujące własności
      1. id - identyfikator wartości
      2. display - nazwa wartości
      3. description - opis wartości
    4. url - url zwracający dane z serwera dla dynamnicznej listy rozwijanej, może być także w postaci funkcjifunkcji zwracającej wartość typu String, która przyjmuje następujące parametry:
      1. options - dodatkowe parametry przekazywane do funkcji
        1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
    5. fields - pola, jakie są zwracane z serwera, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
      1. name - nazwa pola
      2. type - typ pola (string, boolean, integer, float, date)
    6. valueField - nazwa pola, którego wartość ma być ustawiana jako wartość parametru
    7. displayField - nazwa pola, którego wartość jest wyświetlana na liście
    8. pageSize - rozmiar strony (domyślnie: 20)
    9. template - szablon opisujący sposób wyświetlania wartości na liście, właściwość jest tablicą obiektów, z których każdy posiada następujące własności:
      1. label - etykieta dla pola
      2. field - nazwa pola
    10. sort - umozliwia określenie sortowania danych z serwera, właściwość jest obiektem, który posiada następujące własności:
      1. field - nazwa pola, po którym występuje sortowanie
      2. direction - kierunek sortowania (ASC/DESC)
    11. onChange - funkcja wykonywana po wybraniu wartości z listy, przyjmuje następujące parametry:
      1. value - wartość pola parametru
      2. options - dodatkowe parametry przekazywane do funkcji
        1. rowIndex - jeśli pole parametru jest typu tabelarycznego, to rowIndex jest pozycją aktualnego pola parametru w tablicy, pierwsza pozycja ma wartość 0
  13. getFieldPosition(parameterId) - zwraca pozycję pola parametru, jeżeli parametr znajduje się w tabeli, to zwracana jest pozycja pola parametru tabeli
  14. getFieldValue(parameterId, asString) - zwraca wartość pola parametru, wartość może być zwrócona w postaci string (asString=true)
  15. setFieldValue(parameterId, value) - ustawia wartość pola parametru
  16. addButton(Object) - dodaje przycisk na ostatniej pozycji, obiekt definicji zawiera następujące właściwości:
    1. text - teskt przycisku
    2. iconCls - systemowa klasa css dla ikony przycisku
    3. tooltip  - tooltip przycisku
    4. handler - funkcja wykonywana po kliknięciu w przycisk
    5. scope - scope dla funkcji wykonywanej po kliknięciu w przycisk, domyślnie: window
  17. insertButton(position, Object) - dodaje przycisk na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), obiekt definicji zawiera następujące właściwości:
    1. text - teskt przycisku
    2. iconCls - systemowa klasa css dla ikony przycisku
    3. tooltip  - tooltip przycisku
    4. handler - funkcja wykonywana po kliknięciu w przycisk
    5. scope - scope dla funkcji wykonywanej po kliknięciu w przycisk, domyślnie: window
  18. addFieldToArray(parameterId) - dodaje nowe pole na ostatniej pozycji w parametrze tabelarycznym, pole nie jest dodawane do parametru tabelarycznego, który znajduje się w tabeli
  19. removeFieldFromArray(parameterId, position) - usuwa pole z danej pozycji z parametru tabelarycznego, pole nie jest usuwane z parametru tabelarycznego, który znajduje się w tabeli
  20. setFieldValueInArray(parameterId, position, value) - ustawia wartość pola na danej pozycji w parametrze tabelarycznym
  21. getArraySize(parameterId) - zwraca ilość pól w parametrze tabelarycznym lub 0, jeśli pole nie jest parametrem tabelarycznym
  22. resetArray(parameterId) - usuwa pola wiersze (poza pierwszym) z parametru tabelarycznego i czyści wartość pierwszego pola, pola nie są usuwane z parametru tabelarycznego, który znajduje się w tabeli
  23. addTable([ Object / parameterId ], Object) - dodaje tabelę (zbiór pól tabelarycznych) na ostatniej pozycji, obiekt definicji tabeli (drugi parametr) zawiera następujące właściwości:
    1. tableId - identyfikator tabeli, który pozwala ukrywać/pokazywać/usuwać pole
    2. name - nazwa tabeli
    3. description - opis tabeli
    4. hidden - określa, czy tabela ma zostać ukryta
  24. insertTable(position, [ Object / parameterId ], Object) - dodaje tabelę (zbiór pól tabelarycznych) na określonej pozycji (w celu wyznaczenia position dla pola należy korzystać z funkcji getFieldPosition), obiekt definicji tabeli (drugi parametr) zawiera następujące właściwości:
    1. tableId - identyfikator tabeli, który pozwala ukrywać/pokazywać/usuwać pole
    2. name - nazwa tabeli
    3. description - opis tabeli
    4. hidden - określa, czy tabela ma zostać ukryta
  25. addDataChooserMapping(Object) - dodaje mapping data choose'a, ma znaczenie tylko dla komponentu data chooser'a, obiektmappingu zawiera następujące właściwości:
    1. id - id mappingu
    2. description - opis mappingu
    3. variableId - id zmiennej procesu, na którą jest mapowana wybrana wartość w data chooser
    4. name - tekst wyświetlany dla mappingu podczas prezentacji rezultatów data chooser'a na formularzu zadania
    5. hidden - informuje, czy mapping ma być ukryty na formularzu zadania
    6. verify - informuje, czy mapping ma być walidowany na formularzu zadania
    7. readOnly - informuje, które wartości nie mogą być edytowane w danym mappingu, akceptowane wartości to:
      1. true/false - zmienna typu boolean, informuje, że żadna z wartości mappingu nie może być edytowana
      2. string - zmienna typu string, informuje, która z wartości mappingu nie może być edytowana (akceptowane wartości to: id, description, variableId, name, hidden, verify)
      3. array - zmienna tabelaryczna, informuje, które z wartości mappingu nie mogą być edytowane (akceptowane wartości to: id, description, variableId, name, hidden, verify)
  26. resetDataChooserMappings() - usuwa wszystkie mappingi data choose'a, ma znaczenie tylko dla komponentu data chooser'a

...

  1. addValues(Object/Array) - dodaje do listy rozwijanej kolejne pozycje (patrz values w metodzie addCombobox), dotyczy tylko tych list rozwijanych, które działają lokalnie
  2. setValues(Object/Array) - zmienia pozycje na liście rozwijanej (patrz values w metodzie addCombobox), dotyczy tylko tych list rozwijanych, które działają lokalnie
  3. setUrl(url) - ustawia url zwracający dane z serwera, dotyczy tylko tych list rozwijanych, które pobierają dane z serwera, wartość parametru url musi być typu String
  4. setForceSelection(forceSelection) - ustawia wartość pola forceSelection

...