| 95 | | |
| 96 | | {{{ |
| 97 | | #!php |
| 98 | | /** Konstruktor |
| 99 | | * Przygotowuje nazwę dla tagu HTML, źródło requestów, |
| 100 | | * możliwość wielokrotnego wyboru i ustawia tryb pamiętania zawartości. |
| 101 | | * Przywraca ostatnio wybrane pozycje ze schowka. |
| 102 | | * Gdy wybrano tryb pamiętania zawartości przywraca zawartość ze schowka. |
| 103 | | * @param $name nazwa dla tagu HTML |
| 104 | | * @param $source źródło pętli zwrotnej, domyślnie </code>$_POST</code> |
| 105 | | * @param $multiple flaga wielokrotnego wyboru, domyślnie FALSE |
| 106 | | * @param $rememberList tryb pamiętania zawartości, domyślnie FALSE |
| 107 | | */ |
| 108 | | public function __construct($name, $source = NULL, $multiple = FALSE, $rememberList = NULL); |
| 109 | | |
| 110 | | /** Dodaje parę klucz-etykietę do listy |
| 111 | | * Klucz znajdzie się w tagu <code>option</code>, etykieta |
| 112 | | * będzie wyświetlana jako element listy. |
| 113 | | * @param $k klucz |
| 114 | | * @param $v etykieta |
| 115 | | */ |
| 116 | | public function addItem($k, $v, $grpDsc = NULL); |
| 117 | | |
| 118 | | /** Dodaje pary klucz-etykieta z tablicy |
| 119 | | * @param $a tablica asocjacyjna |
| 120 | | * @return boolean sukces/porażka |
| 121 | | */ |
| 122 | | public function addArray($a); |
| 123 | | |
| 124 | | /** Dodaje pary klucz-etykieta z tablicy tablic asocjacyjnych |
| 125 | | * Tablice tablic asocjacyjnych mają postać<code> |
| 126 | | * array( |
| 127 | | * array(klucz => etykieta), |
| 128 | | * array(klucz => etykieta) [...] |
| 129 | | * );</code> |
| 130 | | * @param &$a referencja do tablicy |
| 131 | | * @param $keyName nazwa pola z kluczem |
| 132 | | * @param $valName nazwa pola z etykietą |
| 133 | | * @return boolean sukces/porażka |
| 134 | | * @since 0.12.0 |
| 135 | | */ |
| 136 | | public function addAssocArray($a, $keyName, $valName, $grpDsc = NULL); |
| 137 | | |
| 138 | | /** Usuwa z listy element o podanym kluczu |
| 139 | | * @param $k klucz |
| 140 | | */ |
| 141 | | public function removeItem($k); |
| 142 | | |
| 143 | | /** Usuwa z listy wszystkie elementy i natychmiast uaktualnia schowek*/ |
| 144 | | public function removeAllItems(); |
| 145 | | |
| 146 | | /** Reset */ |
| 147 | | public function reset(); |
| 148 | | |
| 149 | | /** Clear */ |
| 150 | | public function clear(); |
| 151 | | |
| 152 | | /** Zaznacza element listy jako wybrany |
| 153 | | * Gdy nie jest dozwolony wybór wielokrotny czyści tablicę wybranych elementów. |
| 154 | | * @param $k klucz wybranego elementu |
| 155 | | */ |
| 156 | | public function selectItem($k); |
| 157 | | |
| 158 | | /** Zaznacza wszystkie elementy listy jako wybrane */ |
| 159 | | public function selectAllItems(); |
| 160 | | |
| 161 | | /** Zaznacza element listy jako niewybrany |
| 162 | | * @param $k klucz |
| 163 | | */ |
| 164 | | public function deselectItem($k); |
| 165 | | |
| 166 | | /** Zaznacza wszystkie elementy listy jako niewybrane */ |
| 167 | | public function deselectAllItems(); |
| 168 | | |
| 169 | | /** Przełącza element listy wybrany - niewybrany |
| 170 | | * Elementy wybrane stają sie niewybrane i vice versa. |
| 171 | | * @param $k klucz |
| 172 | | */ |
| 173 | | public function toggleItem($k); |
| 174 | | |
| 175 | | /** Zaznacza element listy jako wybrana zgodnie z requestem */ |
| 176 | | public function selectItemOnEvent(); |
| 177 | | |
| 178 | | /** Zwraca wartość, która przyszła w requeście |
| 179 | | * @return klucz tagu SELECT |
| 180 | | */ |
| 181 | | public function getCurrentItem(); |
| 182 | | |
| 183 | | /** Set value*/ |
| 184 | | public function setValue($value); |
| 185 | | |
| 186 | | /** Get value */ |
| 187 | | public function getValue(); |
| 188 | | |
| 189 | | /** Get text*/ |
| 190 | | public function getText(); |
| 191 | | |
| 192 | | /** Zwraca listę wybranych kluczy */ |
| 193 | | public function getSelectedKeys(); |
| 194 | | |
| 195 | | /** Zwraca referencję do tablicy klucz-etykieta z wybranymi elementami */ |
| 196 | | public function &getSelectedItems(); |
| 197 | | |
| 198 | | /** Zwraca referencję do tablicy klucz-etykieta ze wszystkimi elementami */ |
| 199 | | public function &getAllItems(); |
| 200 | | |
| 201 | | /** Ustawia źródło requestów |
| 202 | | * @param $source nazwa źródła |
| 203 | | */ |
| 204 | | public function setSource(&$source); |
| 205 | | |
| 206 | | /** Ustawia parametry formatujące HTML tagu SELECT |
| 207 | | * @param $key nazwa parametru |
| 208 | | * @param $value wartość parametru |
| 209 | | */ |
| 210 | | public function setHtmlFormatting($k, $v); |
| 211 | | |
| 212 | | /** Ustawia parametry CLASS i STYLE tagu HTML |
| 213 | | * @param $class klasa CSS, domyślnie NULL |
| 214 | | * @param $style styl CSS inline, domyślnie NULL |
| 215 | | */ |
| 216 | | public function setCSSFormatting($class = NULL, $style = NULL); |
| 217 | | |
| 218 | | /** Zaraz po wyborze wysyła formularz javascriptem */ |
| 219 | | public function autoSubmit(); |
| 220 | | |
| 221 | | /** Zaraz po wyborze wysyła formularz gdy wartosc nie pusta */ |
| 222 | | public function autoSubmitNotNUll(); |
| 223 | | |
| 224 | | /** Sprawdza poprawność requestu |
| 225 | | * Sprawdza czy źródło requestów istnieje, znajduje się w nim dana |
| 226 | | * i czy dana jest w liście combo boksa. |
| 227 | | * @return boolean |
| 228 | | */ |
| 229 | | public function isRequestValid(); |
| 230 | | |
| 231 | | /** Ustawia rozmiar dla multi-selecta |
| 232 | | * @param $size wiadomo |
| 233 | | */ |
| 234 | | public function setSize($size); |
| 235 | | |
| 236 | | /** Set read only */ |
| 237 | | public function setReadOnly($ro); |
| 238 | | |
| 239 | | /** Enable */ |
| 240 | | public function enable(); |
| 241 | | |
| 242 | | /** Disable */ |
| 243 | | public function disable(); |
| 244 | | |
| 245 | | /** Zwraca flagę read-only całego formularza |
| 246 | | * @return boolean dostępny do zapisu |
| 247 | | */ |
| 248 | | public function isEnabled(); |
| 249 | | |
| 250 | | /** Serializuje widget do HTML i zapamiętuje sesję */ |
| 251 | | public function toHtml(); |
| 252 | | }}} |
