Using Metatags in Flex Developing

Використання метатеґів у розробці RIA- застосунків за допомогою Flex Роман {nouba} Шупер, The Midnight Coders http:// noubase.com спеціально дла 8- ої зустрічі UAFPUG в Миколаєві (20.12.2008) Рівень слухачів: середній - експерт Галузь: Adobe Flex

Спробуємо дати собі відповіді на наступні запитання: Що таке метатеґи? Для чого вони? Як їх застосовувати? Які види метатеґів бувають? Для чого кожен з них служить? Коли і як варто їх застосовувати? Про що я забув сказати або не знав?

1. Що таке метатеґи? Метатеґ – спеціальна конструкція, чітко визначеного формату, яка дає змогу додати певні дані до загального коду програми чи структурувати їх, а також вносити зміни в поведінку компілятора чи доповнювати її потрібними нам директивами. Узагальнене визначення:

[Event(name="myClickEvent", type="flash.events.Event")] 1. Що таке метатеґи? Структура: [ … ] – Тіло метатеґа Event – Тип метатеґа (…) – Перелік всіх полів метатеґа type – Поле метатеґа "myClickEvent" – Значення поля метатега

2 . Для чого вони? Для зручності [Event], [Style], [ArrayElementType], [Effect] … Для спеціальних можливостей [Bindable], [RemoteClass], [Embed], [IconFile] … Для структуризації [Exclude], [ExcludeClass], [Deprecated] …

3 . Як їх застосовувати? В ActionScript 3 :

3 . Як їх застосовувати? В MXML : Всередині теґа <mx:Metadata>

[ ArrayElementType ] [Bindable] [ DefaultProperty ] [ Deprecated ] [Effect] [Embed] [ Event ] [ Exclude ] 09. [ ExcludeClass ] 10. [IconFile] 11. [ Inspectable ] 12. [InstanceType] 13. [NonCommittingChangeEvent] 14. [ RemoteClass ] 15. [ Style ] 16. [ Transient ] 4 . Які види метатеґів бувають? Список і ті, які ми розглянемо далі: Документовані

4 . Які види метатеґів бувають? Список і ті, які ми розглянемо далі: 17. [ Mixin ] 18. [ MaxChildren ] 19. [ PercentProxy ] 20. [ SWF ] 21 . [AccessibilityClass] 22. [ChangeEvent] 23. [ CollapseWhiteSpace ] 24. [ Frame ] 25. … НЕ документовані

[ArrayElementType] Працює тільки в MXML Вказує на допустимий тип елементів масива Мінуси : Плюси: Структурує типи Позбавляє від малопомітних і каверзних помилок з типами Розвінчуємо міфи : Не є аналогом типізованого масива чи Vector’a в А ctionScript 3 FP10. Не додає жодного прискорення в роботі

[ArrayElementType] ActionSctipt3 Class (Fragment) Вказувати повністю з пакетом, за винятком примітивів!

[ArrayElementType] MXML Layout (Fragment) In initializer for 'testArray': type Number is not assignable to target type Array or target element type . ArrayElementType/src main.mxml line 8

[DefaultProperty] Визначає властивість, по замовчуванню, для класа package mx.collections { [ DefaultProperty ( "source" )] public class ArrayCollection …. public function set source(s:Array): void { list = new ArrayList(s); }

[Inspectable] Як це виглядає в коді Увага! Не використовуйте одинарні лапки в описі полів метатеґа! По не зрозумілим причинам метатеґ перестає працювати

[Inspectable] Детальніше про поля метатеґа category Визначає до якої групи належатиме ця властивість в Property Inspector’i Flex Builder’a . Дефолна категорія – “ Other ” .

[Inspectable] Детальніше про поля метатеґа enumeration Це перелік усіх можливих валідних значень для цієї властивості . Сортується завжди за алфавітом. Наприклад: enumeration= “ UAFPUG, BAFPUG, RAFPUG ” перетвориться в наступний список

[Inspectable] Детальніше про поля метатеґа environment defaultValue format listOffset name type variable verbose Ще 8 полів у метатеґа Inspectable , які, нажаль, не мають жодного змісту для Flex- розробника. Усі всі вони використовуються для Flash -компонент, але це вже тема для іншої доповіді  .

“ Кривий” і не зручний парсер значення поля name. Відсутність перевірки правильності вказаного класа в полі type в момент компіляції (в Flex Builder’i , а в IntelliJ IDEA 8 - працює) [Event] Служить для декларації подій які можуть виникнути в компоненті Мінуси : Плюси: Пришвидшує підписку на події. Структурує інформацію про всі можливі події в класі

[Event] В дії ( ActionScript 3 ):

В коді: [Event] Прописуємо метатеґ в нашому класі. В полі type вказує клас повністю з пакетом Створюємо наш власний клас події і добавляємо константу: Зрозуміло, що значення константи TEST_EVENT і поля name повинні співпадати

Між маленькою і великою буквою, або двома великими буквами буде вставлено знак “_” Усі літери між знаками “_” буде піднято в верхні регістр [Event] 2 правила парсера: “ testEvent ” -> TEST_EVENT “ TestEvent ” -> _TEST_EVENT “ TEstEvent ” -> _T_EST_EVENT

[Event] Увага! Це погана практика. Якщо, дуже не хочеться створювати окремий клас події.

[Style] Декларує властивість стиля, а також поведінку цієї властивості та її ознаки. Приклади з Flex framework’a : Усі поля метатеґа name type arrayType 4. format 5. enumeration 6. inherit 7. states

[Style] name Визначає як буде відображатись дана властивість в списку

[Style] enumeration Перелічує усі валідні значення для даної властивості

inherit [Style] Вказує на те чи будуть усі потомки компонента наслідувати цю властивість від нього чи ні

inherit [Style] Червоний <mx:Canvas> не унаслідував суцільну зелену рамку від свого батьківського контейнера

inherit [Style] Як бачимо <mx:Label> унаслідував червоний колір тексту від батьківської <mx:Panel>

type [Style] Визначає який тип готова прийняти ця властивість Абсолютно очікувано, отримуємо помилку

[Style] arrayType Нажаль, на даному етапі розвитку Flex Builder ніяк не реагує на порушення типу даних, але все-таки рекомендую використовувати це поле. Можливо колись вони це поправлять.

format [Style] Має зміст лише для компонентів розроблених для Flash. Знову ж таки це уже тема для іншої доповіді. states Вказує на те, що при розробці класу, який буде використаний для скінування ви можете використовувати стейти з відповідними іменами.

[PercentProxy] В дії на прикладі mx.core.UIComponent: Передає параметр в іншу сеттер-функцію, попередньо вирізавши знак процентів

Працює виключно всередині MXML теґів [ CollapseWhiteSpace ] Мінуси : Плюси: Деколи робить за нас нашу роботу ;)

[ Mixin ] Викликає статичний метод init () ще до конструктора.

[ Mixin ] Хто вгадає який буде output?

[ MaxChildren ] Жодної корисної дії від цього метатеґа не виявлено хоч його і було виявлено в 3 класах Flex Framework’a, a саме: mx.controls.ButtonBar mx.controls.LinkBar mx.controls.TabBar Якщо хтось все-таки знайде користь в цьому чудному метатезі – негайно сповістіть мене 

[ RemoteClass ] Слугує для зв’язування пари класів які повинні мапитись між собою при використанні ORB технологій. ActionScript 3 Class Alias вказується з повним ім’ям включно з пакетом

[ RemoteClass ] Java Class При серіалізації та десереалізації усі поля і методи будуть правильно розпізнані рефлектором

[ Transient ] Слугує для того щоб управляти списком полів та методів які підпадуть під серіалізацію в AMF пакет на стороні Flash- плеєра Поле sum може надалі використовуватись на стороні клієнта і воно ніколи не буде серіалізовано і передано на сервер.

[ ExcludeClass ] Ховає клас від intellisense ’a Flex Builder ’а . Тим не менше, Ви можете спокійного імпортувати й використовувати його. Використовується розробниками Flex framework’a , швидше за все, для внутрішніх цілей, або для тих класів які ще не до кінця відтестовані і не випущені .

[ Exclude ] Дає змогу приховати частину API , яку клас унаслідував від свого суперкласа VBox ховає властивість direction , яку він унаслідував від Box, адже вона уже немає жодного логічного значення

[ Exclude ] [ Exclude (name=" direction ", kind=" property ")] [ Exclude (name=" setFocus ", kind=" method ")] [ Exclude (name=" focusIn ", kind=" event ")] [ Exclude (name=" horizontalGap ", kind=" style ")] [ Exclude (name=" focusInEffect ", kind=" effect ")] Цим метатеґом також можна приховати дію інших метатеґів, таких як : [Style] , [Event] та [Effect] , як показано нижче

[ Deprecated ] Дуже важливий метатеґ для тих хто розробляє власні бібліотеки і підтримує їх, випускаючи нові версії. Використовуйте цей метатеґ на усі методах і властивостях, які являються застарілими для нової версії бібліотеки і мають новий покращений аналог або просто стали непотрібні

[ Deprecated ] При подальшому використанні застарілого метода розробник буде попереджений як значком Так і повідомленням яке ви йому там напишете

[ Deprecated ] Якщо розробник й надалі ігноруватиме наші попередження, то Flex Builder буде постійно нагадувати йому в панельці Problems про використання забороненого метода Уже під час виконання жодних помилок не виникає

[ SWF ] Цей метатеґ не несе жодної користі Flex -розробникам, але часто використовується в чистих ActionScript 3 проектах. За його допомогою ми сконфігурувати деякі параметри кінцевого .swf документа width – ширину нашого застосунка height – висоту нашого застосунка frameRate – частоту кадрів backgroundColor – та колір тла Що ще треба для щастя?

6 . Коли і як варто їх застосовувати? Метатеґи потрібно використовувати побільше й почастіше

Усім дякую за увагу. Запитання?

Using Metatags in Flex Developing

More Related Content

Viewers also liked (18)

Similar to Using Metatags in Flex Developing (20)

Using Metatags in Flex Developing