Znaczniki parametrów

Takie parametry, jak ID widoku, łańcuch i liczby umożliwiają komponentom dodawanie informacji do raportów. Do określania tych parametrów służą znaczniki fp:*Param.
Każdy komponent ma obowiązkowe i opcjonalne znaczniki. Wszystkie znaczniki parametrów mają atrybuty.
Tabela 1. Znaczniki i atrybuty parametrów
Nazwa Opis
Znaczniki parametrów
fp:attrParam Określa atrybut. Na przykład Status w module Wymagania.
fp:checkboxParam Zawiera wartość boolowską true lub false.
fp:critParam Zawiera wartość całkowitą. Na przykład (..., -2, -1, 0, 1, 2, ...).
fp:memberParam Określa członka. Na przykład Administrator.
fp:stringParam Zawiera wartość łańcucha.
fp:viewParam Określa widok. Na przykład „Wszystkie wymagania”.
Atrybuty znaczników parametrów
changeable Obowiązkowy atrybut określający, kiedy parametr zostaje zmieniony. Dotyczy wszystkich znaczników *Param. Ten atrybut ma cztery wartości:
  • Template: zmieniany po utworzeniu lub edycji typu raportu.
  • Runtime: zmieniany po utworzeniu raportu.
  • Never: nie może zostać zmieniony. Jest używany, jeśli wartość jest już znana w momencie tworzenia szablonu. Wartość jest odczytywana z atrybutu defaultvalue.
  • Fetch: Wartość jest pobierana automatycznie. Pobieraną wartość określa wartość atrybutu "name":
    • currentdate: bieżąca data
    • currenttime: bieżąca godzina
    • currentuser: zalogowany użytkownik
    • fortune: "ciasteczko z wróżbą" - za każdym razem nowe. Ta wartość ma zastosowanie, gdy dodane są dodatkowe pliki .jar.
    • numpages: liczba stron w raporcie. Ta wartość jest używana w nagłówkach i stopkach.
    • workspacename: nazwa obszaru roboczego.
    • pageno: bieżący numer strony. Ta wartość jest używana w nagłówkach i stopkach.
id Obowiązkowy atrybut określający identyfikator parametru. Dotyczy wszystkich znaczników *Param. Każdy parametr ma unikalny identyfikator. Tego samego identyfikatora można użyć dla wielu parametrów.

W interfejsie użytkownika widoczny jest tylko pierwszy parametr. Pozostałe parametry kopiują wartości z pierwszego parametru. Ta konwencja jest użyteczna wtedy, gdy te same informacje są wyświetlane w wielu nagłówkach lub gdy jeden widok jest używany w wielu komponentach.

name Obowiązkowy atrybut określający nazwę parametru. Dotyczy wszystkich znaczników *Param. W znaczniku komponentu nazwa jest unikalnym identyfikatorem używanym podczas wyszukiwania parametrów. Typowe nazwy to: viewId, attrId, elementId i pageno.
masterid Identyfikator parametru, który kontroluje parametr. Ten atrybut jest obowiązkowy, ale może nie być używany w zależności od komponentu. Dotyczy znacznika attrParam. Zwykle parametrem głównym jest viewParam. Należy najpierw ustawić parametr główny. W przeciwnym razie nie będzie wiadomo, które atrybuty lub składniki są dostępne.
type Określa typ atrybutu dozwolony dla tego parametru. Ten atrybut jest obowiązkowy, ale może nie być używany w zależności od komponentu. Dotyczy znacznika attrParam. Możliwe jest użycie następujących atrybutów typu:
  • choice: dla atrybutów wyboru
  • number: dla atrybutów liczb całkowitych i zmiennopozycyjnych
  • numbertext: dla atrybutów liczb całkowitych i zmiennopozycyjnych oraz macierzy
  • link: dla atrybutów odsyłaczy i list odsyłaczy
  • all: dla wszystkich typów atrybutów
defaultvalue Parametr przyjmuje wartość defaultvalue po pierwszym utworzeniu lub edycji typu raportu bądź po pierwszym wygenerowaniu raportu. Ten atrybut jest opcjonalny i dotyczy wszystkich znaczników *Param. Wartość domyślna to pusty łańcuch: defaultvalue="".
descr Opis parametru. Ten atrybut jest opcjonalny. Opis jest wyświetlany podczas tworzenia lub edytowania typu raportu bądź podczas generowania raportu. Wartość domyślna to brak opisu: descr="".

Opinia