名前空間・クラス索引

名前空間（ビルトイン）

名前空間

JSCL

Arcadian garden: JavaScript Common Library (Ag:JSCL) が利用する標準の名前空間です。

JSCL.Dom

DOM（Document Object Model）処理に関する機能を集約する名前空間です。

クラス

JSCL.Async.AsyncObject.AbortMessage

非同期処理のフロー制御を行うためのメッセージです。

非同期処理オブジェクトに指定された関数オブジェクトが中断メッセージを返した場合、中断時チェーン処理に制御が移ります。
中断時チェーン処理は終了処理の非同期処理オブジェクト以外の全ての非同期処理をスキップし、終了処理の非同期処理オブジェクトの処理終了後は続くチェーン処理を呼び出しません。
また、終了処理の非同期処理オブジェクトが存在しなかった場合にも続くチェーン処理を呼び出しません。
これは非同期処理のチェーン処理を強制的に中断させることを意味します。

なお、中断メッセージは並列実行される個々の非同期処理オブジェクトチェーンの外側には伝播しないことに注意して下さい。
並列実行される個々の非同期処理オブジェクトチェーンで生成された中断メッセージは並列実行される１つの非同期処理オブジェクトチェーンを強制終了させるだけです。

中断メッセージを生成するには、ショートカット関数であるJSCL.Async.Abort関数を利用します。
共有オブジェクトを明示的に変更したい場合、第1引数に新しいオブジェクトを指定します。

JSCL.Async.AsyncObject.BreakMessage

非同期処理のフロー制御を行うためのメッセージです。

非同期処理オブジェクトに指定された関数オブジェクトがブレイクメッセージを返した場合、非同期処理オブジェクトチェーンの次の非同期処理オブジェクトへ制御が移ります。
繰り返し実行の非同期処理オブジェクトの場合、繰り返し回数が指定の回数に達していなくとも繰り返しを終了します。
これは無限ループする繰り返し実行の非同期処理オブジェクトから脱出する唯一の方法です。

繰り返し実行の非同期処理オブジェクトではない場合、ブレイクメッセージはコンティニュメッセージと意味的に等価です。

ブレイクメッセージを生成するには、ショートカット関数であるJSCL.Async.Break関数を利用します。
共有オブジェクトを明示的に変更したい場合、第1引数に新しいオブジェクトを指定します。

JSCL.Async.AsyncObject.ContinueMessage

非同期処理のフロー制御を行うためのメッセージです。

非同期処理オブジェクトに指定された関数オブジェクトがコンティニュメッセージを返した場合、非同期処理オブジェクトチェーンの次の非同期処理オブジェクトへ制御が移ります。
ただし、繰り返し実行の非同期処理オブジェクトの場合、コンティニュメッセージは次の繰り返しに制御を移すに過ぎないことに注意して下さい。

繰り返し実行の非同期処理オブジェクトではない場合、コンティニュメッセージはブレイクメッセージと意味的に等価です。

コンティニュメッセージを生成するには、ショートカット関数であるJSCL.Async.Continue関数を利用します。
共有オブジェクトを明示的に変更したい場合、第1引数に新しいオブジェクトを指定します。

JSCL.Dom.Outline

アウトライン情報を管理するクラスです。

JSCL.Dom.Outlineクラスの提供するアウトライン機能では、指定のエレメントに格納されている文書に含まれるH1エレメントからH6エレメントまでを抽出してアウトラインを構成します。
構成されたアウトラインは、createTreeMenuメソッドやcreateDropDownMenuメソッドで取り出してドキュメント中に挿入することが可能です。
これにより、ドキュメントの論理構造を元にしたアウトラインのメニュー生成が自動化されます。

JSCL.Dom.Outline.Node

アウトライン情報のノードを管理するクラスです。
JSCL.Dom.Outlineクラスから自動的に生成され、ノードの樹形図構造を保持します。

JSCL.Event.Dispatcher

複数のイベントをリスト管理して、イベント発生時に順次実行するための、イベントディスパッチャです。

JSCL.Input.Validator.ColorValidator

フォームへのフォーカスのON/OFFに際して背景色を変更するための背景色バリデータです。
背景色バリデータ自体は背景色を変更するだけで、入力値のチェック処理などは一切実装されません。

JSCL.Input.Validator.DateValidator

フォームへ年月日の日付入力バリデータを付与するためのバリデータです。
年月日は"yyyy/mm/dd"形式の文字列になるようにフォーマットされます。

入力値は以下の法則により年月日に変換されます。

可変長"y/m/d"形式文字列: yが年、mが月、dが日として判定されます。
yが2桁以下で指定された場合、yが74未満の場合、2000年代として判定されます。
yが2桁以下で指定された場合、yが74以上の場合、1900年代として判定されます。
可変長"m/d"形式文字列: mが月、dが日として判定されます。
年は現在のシステム日付から自動的に取得されます。
固定長"yyyymmdd"形式文字列: yyyyが年、mmが月、ddが日として判定されます。
固定長"yymmdd"形式文字列: yyが年、mmが月、ddが日として判定されます。
yyが74未満の場合、2000年代として判定されます。
yyが74以上の場合、1900年代として判定されます。
固定長"mmdd"形式文字列: mmが月、ddが日として判定されます。
年は現在のシステム日付から自動的に取得されます。

JSCL.Input.Validator.NumberValidator

フォームへ数値入力バリデータを付与するためのバリデータです。

数値入力バリデータは、整数部を3桁区切の","に分割して整形します。
また小数部は指定された精度の分だけ整形されます。
指定精度を超える小数部を指定した場合、越えた部分は切り捨てられます。

JSCL.Input.Validator.PostcodeValidator

フォームへ郵便番号入力バリデータを付与するためのバリデータです。

JSCL.Util.Cookie

HTTP Cookieを簡単に取り扱うためのクラスです。

JSCL.Util.Cookieクラスは指定のパス配下で定義される指定のHTTP Cookieを取得、設定します。
JSCL.Util.Cookieクラスで取得されるHTTP Cookieは更に指定のキーとパラメータによって管理されます。
HTTP Cookieを利用したいHTMLドキュメントは、JSCL.Util.Cookieクラスを特定の名前で常に作成することで、一意にHTTP Cookieから値を入出力することが出来ます。

なお、JSCL.Util.Cookieクラスで管理されるHTTP Cookieは有効期限が定義されません。
これはブラウザを閉じることで破棄されることを意味します。

JSCL.Util.HashMap

ハッシュマップによる連想配列クラスです。
JSCL.Util.HashMapは、JavaScriptのObjectを連想配列として利用した場合の諸処の問題点を解決した完全な実装です。

JavaScriptのObjectは連想配列としての性質を持つため、簡易的な手段としてObjectをそのまま連想配列として利用することが出来ます。
しかしObjectを連想配列として利用した場合、キーがObject.prototypeに登録されているメンバと同一であった場合に不具合が生じるなど、連想配列として安全に利用することは出来ません。
また、文字列以外のキーも利用することは出来ません。

JSCL.Util.HashMapはそれら問題点を解決した連想配列の実装です。
JSCL.Util.HashMapによる連想配列には、文字列以外のキーも基本的にそのまま利用することが出来ます。

ただし、キーの同一性のチェックは非常に厳密であることに注意して下さい。
文字列の"1"と数値の1は一致しません。
同様に文字列の"true"と論理型のtrueも一致しません。

オブジェクト、配列などの参照型は特に注意が必要です。
配列はその要素の全てが出現順序も含め、型に至るまで一致している場合にのみ一致していると見なさます。
オブジェクトはそのメンバの全てが出現順序も含め、型に至るまで一致している場合にのみ一致していると見なさます。
従って、たとえ同一のインスタンスであったとしても「キーの同一性チェックを行う処理と処理の間に要素やメンバ変数の値が変わってしまった場合」には不一致と見なされます。