new Glimpse(options)
Glimpse
A lightweight element wrapper that has no dependencies, no context and
no data binding, but is able to apply a super-simple template.
It's invisible to View, so it's great for creating components, and you
can bind data to it using the `cb-data` attribute to set the data
property of your Glimpse
Parameters:
Name | Type | Description |
---|---|---|
options |
Object | Object containing initialisation options |
Extends
Members
data :*
Arbitrary data
Type:
- *
el :HTMLElement
A reference to this class instance's element
Type:
- HTMLElement
supro
Similar to `super` in ActionScript or Java, this property enables
you to access properties and methods of the super class prototype,
which is the case of JavaScript is the next prototype up the chain
- Inherited From:
- Source:
tagName :string
When a new instance of this class is created without specifying an element,
it will use this tag name (the default is `div`)
Type:
- string
template :string
Template to apply to the Glimpse's element
Type:
- string
Methods
addEventListener(type, handler, scopeopt, priorityopt, onceopt) → {conbo.EventDispatcher}
Add a listener for a particular event type
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
type |
string | Type of event ('change') or events ('change blur') | ||
handler |
function | Function that should be called | ||
scope |
Object |
<optional> |
Options object (recommended) or the scope in which to run the event handler (deprecated) | |
priority |
number |
<optional> |
0 | The event handler's priority when the event is dispatached (deprecated) |
once |
boolean |
<optional> |
false | Should the event listener automatically be removed after it has been called once? (deprecated) |
- Inherited From:
- Source:
Returns:
A reference to this class instance
bindAll(…methodNameopt) → {this}
Scope all methods of this class instance to this class instance
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
methodName |
string |
<optional> <repeatable> |
Specific method names to bind (all will be bound if none specified) |
- Inherited From:
- Source:
Returns:
- Type
- this
declarations() → {void}
Declarations is used to declare instance properties used by this class
Parameters:
Type | Attributes | Description |
---|---|---|
* |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
destroy() → {void}
Clean everything up ready for garbage collection (you should override in your own classes)
- Inherited From:
- Source:
Returns:
- Type
- void
dispatchChange(propName) → {conbo.EventDispatcher}
Dispatch a change event for one or more changed properties
Parameters:
Name | Type | Description |
---|---|---|
propName |
string | The name of the property that has changed |
- Inherited From:
- Source:
Returns:
A reference to this class instance
dispatchEvent(event) → {conbo.EventDispatcher}
Dispatch the event to listeners
Parameters:
Name | Type | Description |
---|---|---|
event |
conbo.Event | The event to dispatch |
- Inherited From:
- Source:
Returns:
A reference to this class instance
hasEventListener(type, handleropt, scopeopt) → {boolean}
Does this object have an event listener of the specified type?
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
type |
string | Type of event (e.g. 'change') | |
handler |
function |
<optional> |
Function that should be called |
scope |
Object |
<optional> |
Options object (recommended) or the scope in which to run the event handler (deprecated) |
- Inherited From:
- Source:
Returns:
True if this object has the specified event listener, false if it does not
- Type
- boolean
initialize() → {void}
Initialize (entry point) is called immediately after the constructor has completed
Parameters:
Type | Attributes | Description |
---|---|---|
* |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
preinitialize() → {void}
Preinitialize is called before any code in the constructor has been run
Parameters:
Type | Attributes | Description |
---|---|---|
* |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
removeEventListener(typeopt, handleropt, scopeopt) → {conbo.EventDispatcher}
Remove a listener for a particular event type
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
type |
string |
<optional> |
Type of event ('change') or events ('change blur'), if not specified, all listeners will be removed |
handler |
function |
<optional> |
Function that should be called, if not specified, all listeners of the specified type will be removed |
scope |
Object |
<optional> |
Options object (recommended) or the scope in which to run the event handler (deprecated) |
- Inherited From:
- Source:
Returns:
A reference to this class instance
toString() → {string}
String representation of the current class
- Overrides:
- Source:
Returns:
- Type
- string