trueを指定すると、jQueryウィジェットを無効にします。

型:Boolean
初期値:false

hideアニメーションの指定をします。

型:Boolean or Number or String or Object
初期値:null

Boolean

falseを指定すると、アニメーションがOFFになります。 trueを指定すると、デフォルトのフェードアウトアニメーションが適用されます。

Number

指定されたミリ秒で、デフォルトのイージングでフェードアウトアニメーションが適用されます。

String

指定されたエフェクト名で要素が非表示になります。 "slideUp"のようなjQueryの組み込みメソッド、または"fold"のようなjQuery UIのエフェクトのどちらかのエフェクト名を指定します。 どちらを指定しても、Durationとイージングはデフォルトのものが適用されます。

Object

オブジェクト型を指定した場合、effect、duration、easingのプロパティが提供されます。 effectプロパティはjQueryメソッド名が指定されればそれを使用し、それ以外の場合はjQuery UIのエフェクト名とみなします。 jQuery UIのエフェクトを使用する場合、追加の設定がサポートされるため、それらの設定を読みこめばエフェクト名として渡されます。 もし、durationまたはeasingが省略された場合はデフォルト値が使用されます。 もし、effedctが省略された場合は"fadeOut"が使用されます。

showアニメーションの指定をします。

型:Boolean or Number or String or Object
初期値:null

Boolean

falseを指定すると、アニメーションがOFFになります。 trueを指定すると、デフォルトのフェードインアニメーションが適用されます。

Number

指定されたミリ秒で、デフォルトのイージングでフェードインアニメーションが適用されます。

String

指定されたエフェクト名で要素が表示されます。 "slideDown"のようなjQueryの組み込みメソッド、または"fold"のようなjQuery UIのエフェクトのどちらかのエフェクト名を指定します。 どちらを指定しても、Durationとイージングはデフォルトのものが適用されます。

Object

オブジェクト型を指定した場合、effect、duration、easingのプロパティが提供されます。 effectプロパティはjQueryメソッド名が指定されればそれを使用し、それ以外の場合はjQuery UIのエフェクト名とみなします。 jQuery UIのエフェクトを使用する場合、追加の設定がサポートされるため、それらの設定を読みこめばエフェクト名として渡されます。 もし、durationまたはeasingが省略された場合はデフォルト値が使用されます。 もし、effedctが省略された場合は"fadeIn"が使用されます。

fn

型:Function() or String
呼び出す関数、またはウィジェット内の関数の文字列を指定します。

delay

型:Number
遅延させる時間をミリ秒単位で指定します。初期値は0です。

//1.8
$.widget( "demo.widget", {
  destroy: function() {
    // 基盤のdestoryメソッドを実行
    $.Widget.prototype.destroy.call( this );
    // ウィジット独自のクリーンアップ処理
    ...
  }
});

//1.9～
$.widget( "demo.widget", {
  _destroy: function() {
    // ウィジット独自のクリーンアップ処理
    ...
  }
});

フォーカスとui-state-focusクラスを適用する要素を指定します。 このイベントハンドラはdestoryメソッドにより自動的に削除されます。

element

フォーカスを適用したい要素(jQuery要素)を指定します。

戻り値:Object

全てのウィジェットはcreateイベントをトリガします。 初期状態であれば、そのイベントでの戻り値はありませんが、このメソッドによって createイベントデータをオブジェクトとして返すことが可能です。

戻り値:Object

ウィジェットがインスタンス化される際に、オプションを定義するためのカスタムメソッドを定義することができます。 デフォルトのオプションを上書きしたものが返されます。

element

型：jQuery
非表示にする要素を指定します。

option

型：Object
要素をどのように非表示にするかの設定を定義します。

callback

型：Function()
要素が完全に非表示にされた後に実行したい関数を指定します。

ホバーとui-state-hoverクラスを適用する要素を指定します。 このイベントハンドラはdestoryメソッドにより自動的に削除されます。

element

ホバーを適用したい要素(jQuery要素)を指定します。

element

型：jQuery
イベントハンドラを削除する要素を指定します。 _on()メソッドとは異なり、要素の指定は必須です。

eventName

型：String
1つ、または複数の空白区切りのイベントタイプを文字列で指定します。

• ハンドラ内で、適切なthisコンテキストを維持します。
• disabled状態、またはui-state-disabledクラスが適用されている時はイベントを実行されません。
• イベントハンドラには自動的に名前空間が適用され、またクリーンアップ時に自動的に削除されます。

element

型：jQuery
イベントハンドラを登録する要素(jQuery要素)を指定します。 もし、指定がない場合は、this.element(プラグイン指定した要素自身)が対象になります。

handlers

型：Object
マップ値を指定します。 キーには、イベントタイプとデリゲーションのための任意のセレクタ名の文字列を指定します。
値には、イベント時に実行するハンドラ関数を指定します。

this._on( someElement, {
  mousedown: function( event ) {
    this._handleDown();
  },
  mouseup: "_handleUp",
  "click .other-element": function( event ) {
    this._handleClick( event.target );
  }
});

key

型：String
オプション名を指定します。

value

型：Object
オプションにセットする値を指定します。

option()メソッド(呼び出しの型に関係なく)が呼び出される度に、実行されるメソッドです。 (※翻訳に自信無し)複数のオプションを変更するために、集中的な処理を遅らせることが出来る場合に上書きすると便利です。

options

型：Object
オプションにセットするキーと値のペアとなるマップ値を指定します。

element

型：jQuery
表示する要素を指定します。

option

型：Object
要素をどのように表示するかの設定を定義します。

callback

型：Function()
要素が完全に表示された後に実行したい関数を指定します。

arguments

型：Array
親メソッドに渡す引数を指定します。

イベントをトリガします。 typeに指定したイベントが、コールバック関数のように呼び出されます。 イベント名は「ウィジット名＋type」になります。

dataを提供する場合は、3つの引数を指定する必要があります。 eventが無いのであればnullを指定してください。

type

型：String
コールバックオプションの名前に一致する必要があります。 完全なイベント名は自動的に生成されます。

event

型：Event
このイベントを発生させた元のイベントを指定します。 リスナーにこの情報を提供する際に有用です。

data

型：Object
このイベントに関連するハッシュデータを渡します。

戻り値：Object

optionNameに指定したオプションの現在の値を取得します。

optionName

型：String
取得したいオプションの名前を指定します。

戻り値：PlainObject

オプションの各キーと値がペアとなったオブジェクトを返します。

引数のoptionNameのオプションに値を設定します。

optionName

型：String
設定したいオプションの名前を指定します。

value

型：Object
設定したい値を指定します。

オプションに設定したい各キーと値がペアとなったオブジェクトを指定します。

option

型：Object
設定したいオプションのキーと名前のペアを指定します。

型：widgetcreate

ウィジットが作成される際にトリガされます。

//ウィジットの初期化時にcreateコールバックを指定します。
$( ".selector" ).widget({
  create: function( event, ui ){
    //…
  }
});

//widgetcreate(create)イベントに処理を登録しています。
$(".selector").on("widgetcreate", function(event, ui){
  //…
});