| | 26 | == Komponent ModernSelect == |
| | 27 | |
| | 28 | Metody |
| | 29 | {{{ |
| | 30 | /** Konstruktor |
| | 31 | * Przygotowuje nazwę dla tagu HTML, źródło requestów, |
| | 32 | * możliwość wielokrotnego wyboru i ustawia tryb pamiętania zawartości. |
| | 33 | * Przywraca ostatnio wybrane pozycje ze schowka. |
| | 34 | * Gdy wybrano tryb pamiętania zawartości przywraca zawartość ze schowka. |
| | 35 | * @param $name nazwa dla tagu HTML |
| | 36 | * @param $source źródło pętli zwrotnej, domyślnie </code>$_POST</code> |
| | 37 | * @param $multiple flaga wielokrotnego wyboru, domyślnie FALSE |
| | 38 | * @param $rememberList tryb pamiętania zawartości, domyślnie FALSE |
| | 39 | */ |
| | 40 | public function __construct($name, $source = NULL, $multiple = FALSE, $rememberList = NULL); |
| | 41 | |
| | 42 | /** Dodaje parę klucz-etykietę do listy |
| | 43 | * Klucz znajdzie się w tagu <code>option</code>, etykieta |
| | 44 | * będzie wyświetlana jako element listy. |
| | 45 | * @param $k klucz |
| | 46 | * @param $v etykieta |
| | 47 | */ |
| | 48 | public function addItem($k, $v, $grpDsc = NULL); |
| | 49 | |
| | 50 | /** Dodaje pary klucz-etykieta z tablicy |
| | 51 | * @param $a tablica asocjacyjna |
| | 52 | * @return boolean sukces/porażka |
| | 53 | */ |
| | 54 | public function addArray($a); |
| | 55 | |
| | 56 | /** Dodaje pary klucz-etykieta z tablicy tablic asocjacyjnych |
| | 57 | * Tablice tablic asocjacyjnych mają postać<code> |
| | 58 | * array( |
| | 59 | * array(klucz => etykieta), |
| | 60 | * array(klucz => etykieta) [...] |
| | 61 | * );</code> |
| | 62 | * @param &$a referencja do tablicy |
| | 63 | * @param $keyName nazwa pola z kluczem |
| | 64 | * @param $valName nazwa pola z etykietą |
| | 65 | * @return boolean sukces/porażka |
| | 66 | * @since 0.12.0 |
| | 67 | */ |
| | 68 | public function addAssocArray($a, $keyName, $valName, $grpDsc = NULL); |
| | 69 | |
| | 70 | /** Usuwa z listy element o podanym kluczu |
| | 71 | * @param $k klucz |
| | 72 | */ |
| | 73 | public function removeItem($k); |
| | 74 | |
| | 75 | /** Usuwa z listy wszystkie elementy i natychmiast uaktualnia schowek*/ |
| | 76 | public function removeAllItems(); |
| | 77 | |
| | 78 | /** Reset */ |
| | 79 | public function reset(); |
| | 80 | |
| | 81 | /** Clear */ |
| | 82 | public function clear(); |
| | 83 | |
| | 84 | /** Zaznacza element listy jako wybrany |
| | 85 | * Gdy nie jest dozwolony wybór wielokrotny czyści tablicę wybranych elementów. |
| | 86 | * @param $k klucz wybranego elementu |
| | 87 | */ |
| | 88 | public function selectItem($k); |
| | 89 | |
| | 90 | /** Zaznacza wszystkie elementy listy jako wybrane */ |
| | 91 | public function selectAllItems(); |
| | 92 | |
| | 93 | /** Zaznacza element listy jako niewybrany |
| | 94 | * @param $k klucz |
| | 95 | */ |
| | 96 | public function deselectItem($k); |
| | 97 | |
| | 98 | /** Zaznacza wszystkie elementy listy jako niewybrane */ |
| | 99 | public function deselectAllItems(); |
| | 100 | |
| | 101 | /** Przełącza element listy wybrany - niewybrany |
| | 102 | * Elementy wybrane stają sie niewybrane i vice versa. |
| | 103 | * @param $k klucz |
| | 104 | */ |
| | 105 | public function toggleItem($k); |
| | 106 | |
| | 107 | /** Zaznacza element listy jako wybrana zgodnie z requestem */ |
| | 108 | public function selectItemOnEvent(); |
| | 109 | |
| | 110 | /** Zwraca wartość, która przyszła w requeście |
| | 111 | * @return klucz tagu SELECT |
| | 112 | */ |
| | 113 | public function getCurrentItem(); |
| | 114 | |
| | 115 | /** Set value*/ |
| | 116 | public function setValue($value); |
| | 117 | |
| | 118 | /** Get value */ |
| | 119 | public function getValue(); |
| | 120 | |
| | 121 | /** Get text*/ |
| | 122 | public function getText(); |
| | 123 | |
| | 124 | /** Zwraca listę wybranych kluczy */ |
| | 125 | public function getSelectedKeys(); |
| | 126 | |
| | 127 | /** Zwraca referencję do tablicy klucz-etykieta z wybranymi elementami */ |
| | 128 | public function &getSelectedItems(); |
| | 129 | |
| | 130 | /** Zwraca referencję do tablicy klucz-etykieta ze wszystkimi elementami */ |
| | 131 | public function &getAllItems(); |
| | 132 | |
| | 133 | /** Ustawia źródło requestów |
| | 134 | * @param $source nazwa źródła |
| | 135 | */ |
| | 136 | public function setSource(&$source); |
| | 137 | |
| | 138 | |
| | 139 | /** Ustawia parametry formatujące HTML tagu SELECT |
| | 140 | * @param $key nazwa parametru |
| | 141 | * @param $value wartość parametru |
| | 142 | */ |
| | 143 | public function setHtmlFormatting($k, $v); |
| | 144 | |
| | 145 | /** Ustawia parametry CLASS i STYLE tagu HTML |
| | 146 | * @param $class klasa CSS, domyślnie NULL |
| | 147 | * @param $style styl CSS inline, domyślnie NULL |
| | 148 | */ |
| | 149 | public function setCSSFormatting($class = NULL, $style = NULL); |
| | 150 | |
| | 151 | /** Zaraz po wyborze wysyła formularz javascriptem */ |
| | 152 | public function autoSubmit(); |
| | 153 | |
| | 154 | /** Zaraz po wyborze wysyła formularz gdy wartosc nie pusta */ |
| | 155 | public function autoSubmitNotNUll(); |
| | 156 | |
| | 157 | /** Sprawdza poprawność requestu |
| | 158 | * Sprawdza czy źródło requestów istnieje, znajduje się w nim dana |
| | 159 | * i czy dana jest w liście combo boksa. |
| | 160 | * @return boolean |
| | 161 | */ |
| | 162 | public function isRequestValid(); |
| | 163 | |
| | 164 | /** Ustawia rozmiar dla multi-selecta |
| | 165 | * @param $size wiadomo |
| | 166 | */ |
| | 167 | public function setSize($size); |
| | 168 | |
| | 169 | /** Set read only */ |
| | 170 | public function setReadOnly($ro); |
| | 171 | |
| | 172 | /** Enable */ |
| | 173 | public function enable(); |
| | 174 | |
| | 175 | /** Disable */ |
| | 176 | public function disable(); |
| | 177 | |
| | 178 | /** Zwraca flagę read-only całego formularza |
| | 179 | * @return boolean dostępny do zapisu |
| | 180 | */ |
| | 181 | public function isEnabled(); |
| | 182 | |
| | 183 | /** Serializuje widget do HTML i zapamiętuje sesję */ |
| | 184 | public function toHtml(); |
| | 185 | }}} |
| | 186 | |
| | 187 | Przykład tworzenia obiektu |
| | 188 | {{{ |
| | 189 | $select = new ModernSelect('myselect'); |
| | 190 | $select->setCSSFormatting(NULL, 'width:200px; left:10px; top:10px; position:absolute;'); |
| | 191 | $select->setHTMLFormatting('onchange', 'App.mySelectOnChange(this.value);'); |
| | 192 | |
| | 193 | $select->addItem(1, Translator::translate('One')); |
| | 194 | $select->addItem(2, Translator::translate('Two')); |
| | 195 | $select->addItem(3, Translator::translate('Three')); |
| | 196 | |
| | 197 | $select->selectItem(2); |
| | 198 | |
| | 199 | /** |
| | 200 | * setRightsChecker |
| | 201 | * |
| | 202 | * @param IFieldsRightsChecker $rightsChecker |
| | 203 | * @param string $alias |
| | 204 | * @final |
| | 205 | * @return void |
| | 206 | */ |
| | 207 | final public function setRightsChecker(IFieldsRightsChecker $rightsChecker, $alias = FALSE); |
| | 208 | |
| | 209 | /** |
| | 210 | * setFieldValidator |
| | 211 | * |
| | 212 | * @param IFieldValidator $fieldValidator |
| | 213 | * @param string $alias |
| | 214 | * @return void |
| | 215 | */ |
| | 216 | final public function setFieldValidator(IFieldValidator $fieldValidator, $alias = FALSE); |
| | 217 | |
| | 218 | /** |
| | 219 | * getRightsChecker |
| | 220 | * |
| | 221 | * @final |
| | 222 | * @return void |
| | 223 | */ |
| | 224 | final public function getRightsChecker(); |
| | 225 | |
| | 226 | /** |
| | 227 | * getFieldValidator |
| | 228 | * |
| | 229 | * @return void |
| | 230 | */ |
| | 231 | final public function getFieldValidator(); |
| | 232 | |
| | 233 | /** |
| | 234 | * setAlias |
| | 235 | * |
| | 236 | * @param string $alias |
| | 237 | * @return void |
| | 238 | */ |
| | 239 | final public function setAlias($alias); |
| | 240 | |
| | 241 | /** |
| | 242 | * getAlias |
| | 243 | * |
| | 244 | * @final |
| | 245 | * @return void |
| | 246 | */ |
| | 247 | final public function getAlias(); |
| | 248 | |
| | 249 | /** |
| | 250 | * isPermitted |
| | 251 | * |
| | 252 | * @param string $alias |
| | 253 | * @return void |
| | 254 | */ |
| | 255 | final public function isPermitted($alias = FALSE); |
| | 256 | |
| | 257 | /** |
| | 258 | * isRequired |
| | 259 | * |
| | 260 | * @param string $alias |
| | 261 | * @return void |
| | 262 | */ |
| | 263 | final public function isRequired($alias = FALSE); |
| | 264 | |
| | 265 | |
| | 266 | }}} |