DQ リファレンス
継承やクラス作成に関わる関数群
ライブラリの基本となる関数群
dqextend
| 関数 | 戻り値 | 説明 |
|---|---|---|
|
dqextend (s:object, c:function, m:prototype, p:property) |
object |
オブジェクトをextendパターンで継承します。sに継承元のオブジェクトを指定し、cにコンストラクタとなる関数を指定します。mにはprototypeとして追加する属性値を含んだオブジェクトを指定します。 pにはプロパティを含むオブジェクトを指定します。 |
__dqsuper__
| 関数 | 戻り値 | 説明 |
|---|---|---|
|
__dqsuper__ (me:object, f:string, a:Array) |
object |
継承元のメソッドを呼び出します。たとえばtoStringというメソッドをオーバーライドした場合は以下の様に使用します。
toString: function() {
__dqsuper__(this, "toString", arguments);
//自分のコード
}
|
名前空間 DQ
DQライブラリの基底となる名前空間です。DQに含まれるのは下位の名前空間もしくはスタティックな関数群です。メンバー
| 変数 | 型 | 説明 |
|---|---|---|
| DQ.chain | Array({update: function}) |
周期タイマーで呼び出されるオブジェクトを登録します。オブジェクトにはupdateメソッドが必要です。
|
メソッド
| メソッド | 戻り値 | 説明 |
|---|---|---|
| DQ.format(fmt:string,...) | String |
簡易な書式機能を提供します。書式となるfmtに'{数値}'を挿入することで続く引数をfmtの任意の位置に挿入します。
DQ.format('表示結果[{0}]', 'Hello, world!');
|
| DQ.cookie(key:string, value?:string) | String | keyで指定されたcookieを取得または設定します。 |
| DQ.fps(value:number) | Number | 期待する周期タイマーの分解能をFPSで取得または設定します。タイマーの精度は15.625msです。 |
| DQ.options(org:object,def:object) | object |
orgに対して不足している値をデフォルト値defを元に設定します。
options = {a: 0, b: true}
options = DQ.options(options, {
a: 1,
b: false,
c: "value"
});
//optionsを一覧すると以下のとおり
a: 0
b: true
c: "value"
|
| DQ.start() | void | 周期タイマーを開始します。周期は、DQ.fps()で指定(フレーム単位)します。 |
| DQ.stop() | void | 周期タイマーを停止します。 |
| DQ.storage(key:string, value?:string) | string |
keyをキーとしてvalueをローカルストレージへ保存または取得します。
|
| DQ.lazyLoad(url:string, ctl:string, fn?:function) | void |
urlで指定されたJavaScriptを遅延ロードします。遅延ロード完了を判定するためにctlで指定したオブジェクトが存在するかどうかを確認します。
遅延ロードが完了するとfnが呼び出されます。
|
クラス DQ.Control
UIを持つDQライブラリ内のオブジェクトの基底となるクラスです。コンストラクタ
| コンストラクタ | 説明 |
|---|---|
| DQ.Control(parent:DQ.Control, options:Object, object:String) | objectで指定された要素(のID)を元にコントロールを作成して、指定の親コントロールとひもづけます。 |
メンバー
変数
| メソッド | 戻り値 | 説明 |
|---|---|---|
| client | jQuery |
Controlに含まれるclient領域のdiv要素を指すjQueryオブジェクトを取得または設定します。 デフォルトではthis.objと同じ要素を指します。 |
| dqid | String | dqのコントロール名を取得または設定します。 |
| obj | jQuery | Controlのもっとも外側の要素を指すjQueryオブジェクトを取得または設定します。 |
| controls | Array | 子コントロールのリストを保持する配列を取得または設定します。 |
| parent | DQ.Control | 親コントロールを取得または設定します。 |
プロパティ
| メソッド | 戻り値 | 説明 |
|---|---|---|
| enabled(value?) | jQuery | Controlが操作可能かを取得または設定します。 |
| height(value?) | Number | Controlの高さを取得または設定します。 |
| html(value?) | String | ControlのDOM要素からinnerHTMLを取得または設定します。 |
| hasChildren() | Boolean | Controlに子コントロールが格納されているかを取得します。 |
| size(width?, height?) | DQ.Size | Controlの幅と高さを指定します。 |
| tabIndex(value?) | Number | Controlのタブオーダーを取得または設定します。 |
| tabStop() | Boolean | ControlがTabキーで自信にフォーカスを移すことができるかを示す値を取得します。 |
| text(value?) | String | Controlに関連づけられた文字列を取得または設定します。DOMへ反映されるかはオーバーロードしたControlに依存します。 |
| width(value?) | Number | Controlの幅を取得または設定します。 |
| visible(value?) | Boolean | Controlが表示されているかどうかを取得または設定します。 |
メソッド
| メソッド | 戻り値 | 説明 |
|---|---|---|
| append(element:DQ.Control, add?:Boolean) | None |
elementを子コントロールとしてリストをへ追加し、this._addControl()を呼び出します。 addにTrueを指定した場合、this.objへもDOM要素を追加します this.obj.append(element.obj));
|
| bringToFront() | None | コントロールを親コントロールに含まれるコントロールの最前面に移動します。 DOM要素にzIndexが指定されている場合は必ずしも期待通りに動作しません。 |
| dispose() | None | Controlによって使用されリソースを解放します。 |
| focus() | None | Controlに入力フォーカスを設定します。Controlが入力フォーカスを設定できない場合は意味がありません。 |
| hide() | None | Controlを非表示にします。 |
| remove(control:DQ.Control) | None | 指定された子コントロールをcontrolsから取り除きます。 |
| sendToBack() | None | コントロールを親コントロールに含まれるコントロールの最背面に移動します。 DOM要素にzIndexが指定されている場合は必ずしも期待通りに動作しません。 |
| select() | None | Controlをアクティブにします。 |
| selectNextControl() | None | 次のControlをアクティブにします。 |
| show() | None | Controlを表示します。 |
| findForm() | DQ.Control | Controlが所属するDQ.UI.Formを取得します。 |
クラス DQ.Page
ページを指すControlです。TopレベルのフォームかFormを使用しない場合の親コントロールとして使用します。コンストラクタ
| コンストラクタ | 説明 |
|---|---|
| DQ.Page() |
DQ.Pageコントロールを初期化します。 通常は新規にDQ.Pageコントロールを作成する必要はなく、DQ.page()関数を使用してください。 |
メンバー
変数
| メソッド | 戻り値 | 説明 |
|---|---|---|
| client | jQuery |
Controlに含まれるclient領域のdiv要素を指すjQueryオブジェクトを取得または設定します。 デフォルトではthis.objと同じ要素を指します。(DQ.Controlから継承されます。) |
| dqid | String | dqのコントロール名を取得または設定します。(DQ.Controlから継承されます。) |
| obj | jQuery | Controlのもっとも外側の要素を指すjQueryオブジェクトを取得または設定します。(DQ.Controlから継承されます。) |
| controls | Array | 子コントロールのリストを保持する配列を取得または設定します。(DQ.Controlから継承されます。) |
| parent | DQ.Control | 親コントロールを取得または設定します。(DQ.Controlから継承されます。) |
プロパティ
| メソッド | 戻り値 | 説明 |
|---|---|---|
| enabled(value?) | jQuery | Controlが操作可能かを取得または設定します。 (DQ.Controlから継承されます。) |
| height(value?) | Number | Controlの高さを取得または設定します。(DQ.Controlから継承されます。) |
| html(value?) | String | ControlのDOM要素からinnerHTMLを取得または設定します。(DQ.Controlから継承されます。) |
| hasChildren() | Boolean | Controlに子コントロールが格納されているかを取得します。(DQ.Controlから継承されます。) |
| size(width?, height?) | DQ.Size | Controlの幅と高さを指定します。(DQ.Controlから継承されます。) |
| tabIndex(value?) | Number | Controlのタブオーダーを取得または設定します。(DQ.Controlから継承されます。) |
| tabStop() | Boolean | ControlがTabキーで自信にフォーカスを移すことができるかを示す値を取得します。(DQ.Controlから継承されます。) |
| text(value?) | String | Controlに関連づけられた文字列を取得または設定します。DOMへ反映されるかはオーバーロードしたControlに依存します。(DQ.Controlから継承されます。) |
| width(value?) | Number | Controlの幅を取得または設定します。(DQ.Controlから継承されます。) |
| visible(value?) | Boolean | Controlが表示されているかどうかを取得または設定します。(DQ.Controlから継承されます。) |
メソッド
| メソッド | 戻り値 | 説明 |
|---|---|---|
| append(element:DQ.Control, add?:Boolean) | None |
elementを子コントロールとしてリストをへ追加し、this._addControl()を呼び出します。 addにTrueを指定した場合、this.objへもDOM要素を追加します this.obj.append(element.obj));(DQ.Controlから継承されます。)
|
| bringToFront() | None | コントロールを親コントロールに含まれるコントロールの最前面に移動します。 DOM要素にzIndexが指定されている場合は必ずしも期待通りに動作しません。 (DQ.Controlから継承されます。) |
| dispose() | None | Controlによって使用されリソースを解放します。(DQ.Controlから継承されます。) |
| focus() | None | Controlに入力フォーカスを設定します。Controlが入力フォーカスを設定できない場合は意味がありません。(DQ.Controlから継承されます。) |
| hide() | None | Controlを非表示にします。(DQ.Controlから継承されます。) |
| remove(control:DQ.Control) | None | 指定された子コントロールをcontrolsから取り除きます。(DQ.Controlから継承されます。) |
| sendToBack() | None | コントロールを親コントロールに含まれるコントロールの最背面に移動します。 DOM要素にzIndexが指定されている場合は必ずしも期待通りに動作しません。 (DQ.Controlから継承されます。) |
| select() | None | 子Controlで最前面にあるコントロールをアクティブにします。 |
| selectNextControl() | None | 次のControlをアクティブにします。(DQ.Controlから継承されます。) |
| show() | None | Controlを表示します。(DQ.Controlから継承されます。) |
| findForm() | DQ.Control | Controlが所属するDQ.UI.Formを取得します。 |
