new Check(options)
Collapsible checkbox collection
Parameters:
| Name | Type | Description |
|---|---|---|
options |
nyc.Choice.Options | Constructor options |
- Source:
Extends
Members
container :JQuery
A JQuery element representation of the container
Type:
- JQuery
- Inherited From:
- Source:
currentVal :JQuery
A JQuery element used to display a readable representation of the current value
Type:
- JQuery
- Inherited From:
- Source:
expanded :JQuery.Event
Proxy the expand event
Type:
- JQuery.Event
- Inherited From:
- Source:
Methods
changed(event)
Parameters:
| Name | Type | Description |
|---|---|---|
event |
JQuery.Event | The change event object |
- Overrides:
- Source:
disabled(choiceValue, enabled)
Enable/disable a radio button
Parameters:
| Name | Type | Description |
|---|---|---|
choiceValue |
string | The value of the radio button to disable/enable |
enabled |
boolean | The value of enabled |
- Inherited From:
- Source:
off(eventName, evtHdlr, hdlrScopeopt)
Remove a previously connected event handler
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | The name of the event to which the handler will be connected | |
evtHdlr |
function | The event handler function | |
hdlrScope |
Object |
<optional> |
The scope in which to invoke the event handler |
- Inherited From:
- Source:
on(eventName, evtHdlr, hdlrScopeopt)
Connect a function to an event
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | The name of the event to which the handler will be connected | |
evtHdlr |
function | The event handler function | |
hdlrScope |
Object |
<optional> |
The scope in which to invoke the event handler |
- Inherited From:
- Source:
one(eventName, evtHdlr, hdlrScopeopt)
Connect a function to an event for a single invocation
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | The name of the event to which the handler will be connected | |
evtHdlr |
function | The event handler function | |
hdlrScope |
Object |
<optional> |
The scope in which to invoke the event handler |
- Inherited From:
- Source:
setChoices()
Enable/disable a radio button
Properties:
| Name | Type | Description |
|---|---|---|
choices |
Array.<nyc.Choice.Choice> | The choices for the user |
- Inherited From:
- Source:
trigger(eventName, dataopt)
Trigger a named event with event data
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | The name of the event to trigger | |
data |
Object |
<optional> |
The event data |
- Inherited From:
- Source:
val() → {Array.<nyc.Choice.Choice>}
Returns the value of the radio button collection
- Inherited From:
- Source:
Returns:
The value of the choice control
- Type
- Array.<nyc.Choice.Choice>
Events
change
The change event
Type:
- Array.<nyc.Choice.Choice>
- Inherited From:
- Source: