YahooUserInterfaceのAPIの見方が分かってきた

YahooUserInterfaceのAPIの見方がだんだん分かってきた

例としてYahoo.widget.CalendarのAPIを見てみる。

サイドバーの項目について

このような項目がある

  • Modules
  • Classes
  • Files
  • Properties
  • Methods
  • Events
  • Configuration Attributes
Modules

モジュール(部品)の一覧。このクラスに関係ない奴も混じってるので気にしない。

Classes

このモジュールに含まれているクラスと、このモジュール内で利用している他のモジュールのクラス。今回のCalendarクラスの場合、カレンダーモジュールに含まれるクラスの一覧とここで利用してるYAHOO.widget.DateMathが書いてある。

Files

このモジュールに関連するjsファイル。上で取り上げたClassesを含んでるファイル。

Properties

このクラスの持ってるプロパティ。例えば今回のCalenderクラスにはcellDatesっていうプロパティが含まれてる。ちなみにスーパークラスから継承してるプロパティはここには含まれてない。スーパークラスから継承してるプロパティはメイン部分に書かれてる(後で説明する)。

Methods

このクラスで定義されてるメソッド。プロパティと同じようにスーパークラスから継承してるメソッドは書かれていない(メイン部分に書かれてる)。

Events

このクラスで定義されてるイベント。要するにこのクラスを使ってるときに発生するイベント。この項目もスーパークラスで定義されてるイベントは書かれていない(メイン部分に書かれてる)。

Configuration Attributes

Propertiesの項目にcfgっていうYAHOO.util.Configのインスタンスが含まれてるんだけど、このcfgを使って定義されてる属性。こっちもプロパティみたいなもんなんだけど、使い方が異なる。


例えばCalendarではカレンダーの名前をあらわすConfiguration Attributesとしてtitleっていうのが定義されてる。cfgを次のように利用するとこの値が取れたり、設定できたりする。

get

calendar.cfg.getProperty("title");

set

calendar.cfg.setProperty("title","ここにタイトルを入れます",false);

YAHOO.util.ConfigのsetPropertyの項目を見ると三番目の引数はsilent となっている。説明を読んでみるとtrueにしていると値がセットされたときにconfigChangedイベントが発生する。falseなら発生させないということらしい。多分あまりこのイベントは使わないだろうし、基本的にはfalseでいいと思う。


サイドバーの部分について説明した。次はメイン部分の説明。続きは長くなったから、別のエントリーとして書いた。

YahooUserInterfaceのAPIの見方が分かってきた その2