Class

Validatable

Validatable()

VPValidatable Generic

Constructor

# new Validatable()

Generic instance all Validatable instances inherit from. Defines default shared logic and interfaces.

View Source Validatable.ts, line 16

Extends

Classes

Validatable

Methods

# addEventListener(event_name, callback)

Add an event listener

Parameters:
Name Type Description
event_name string

Name of the event

callback EventCallback

Event callback to fire

Overrides:

View Source mixins/EventEmitter.ts, line 22

# addMessage(message, statusopt)

Adds a unique message to the $MessageNode

Parameters:
Name Type Attributes Description
message

The message to append

status <optional>

An optional class to append indicating message status

Overrides:

View Source lib/DOMMessaging.ts, line 104

If the $MessageNode isn't set or isn't an HTMLElement

# addMessages(messages, statusopt)

Batch append messages

Parameters:
Name Type Attributes Description
messages

The messages to append

status <optional>

An optional class to append indicating message status

Overrides:

View Source lib/DOMMessaging.ts, line 125

If the $MessageNode isn't set or isn't an HTMLElement

# clearMessages()

Clear all messages from the $MessageNode (If set)

Overrides:

View Source lib/DOMMessaging.ts, line 146

# createEvent(event_name, options) → {Event}

Helper for creating a new event, supporting IE9

Parameters:
Name Type Description
event_name string

Name of the event

options EventOptions

Event options

Overrides:

View Source mixins/EventEmitter.ts, line 70

Event

# dispatchEvent(event, data) → {boolean}

Include support for passing data along event

Parameters:
Name Type Description
event Event

the Event object to dispatch

data any

Data to be passed to the callback

Overrides:

View Source mixins/EventEmitter.ts, line 52

boolean

# generateMessageNode(anchoropt, posopt)

Generate a messageNode where messages can be added and removed in a managed way.

Parameters:
Name Type Attributes Description
anchor <optional>

The anchor to use for the $MessageNode (Defaults to $MessageAnchor)

pos <optional>

The position to set $MessageNode inside the $MessageAnchor

Overrides:

View Source lib/DOMMessaging.ts, line 68

If anchor isn't an Element

If pos isn't a valid

VerticalPosition

# isElementVisible(element)

Helper method to determine if the element is visible within the DOM

Parameters:
Name Type Description
element HTMLElement

Element to test

View Source Validatable.ts, line 149

boolean

# removeEventListener(event_name, callback) → {EventCallback|null}

Remove an event listener

Parameters:
Name Type Description
event_name string

Name of the event

callback EventCallback

The event callback to remove

Overrides:

View Source mixins/EventEmitter.ts, line 34

EventCallback | null

# removeMessage(message)

Remove a message

Parameters:
Name Type Description
message

The message to remove

Overrides:

View Source lib/DOMMessaging.ts, line 135

If the $MessageNode isn't set or isn't an HTMLElement

# removeMessageNode()

Removes the $MessageNode from the $MessageAnchor

Overrides:

View Source lib/DOMMessaging.ts, line 92

If the $MessageNode isn't set or isn't an HTMLElement

# scrollTo()

Scroll to the tracked element

View Source Validatable.ts, line 86