Members
-
container :external:Element
-
Details
-
id :string
-
Details
-
logger :NexusHoratio.base.Logger
-
Details
-
name :string
-
Details
-
visible :boolean
-
Details
-
columns :Array.<NexusHoratio.widget.GridColumn>
-
Details
-
data :Array.<object>
-
Details
Methods
-
build() → {NexusHoratio.widget.Widget}
-
Description
Materialize the contents into the container.
Each time this is called, the Widget should repopulate the contents.
Returns
Fires
Details
-
destroy() → {NexusHoratio.widget.Widget}
-
Description
Tears down internals. E.g., any Widget that has other Widgets should call their destroy() method as well.
Returns
Fires
Details
-
show() → {NexusHoratio.widget.Widget}
-
Description
Shows the Widget by removing a CSS class.
Returns
Fires
Details
-
hide() → {NexusHoratio.widget.Widget}
-
Description
Hides the Widget by adding a CSS class.
Returns
Fires
Details
-
verify() → {NexusHoratio.widget.Widget}
-
Description
Verifies a Widget's internal state.
For example, a Widget may use this to enforce certain ARIA criteria.
Returns
Fires
Details
-
clear()
-
Description
Clears the container element.
Details
-
on( eventType, func ) → {NexusHoratio.widget.Widget}
-
Description
Attach a function to an eventType.
Parameters
Name Type Description eventTypestring Event type to connect with.
funcNexusHoratio.base.Dispatcher~Handler Single argument function to call.
Returns
Details
-
off( eventType, func ) → {NexusHoratio.widget.Widget}
-
Description
Remove all instances of a function registered to an eventType.
Parameters
Name Type Description eventTypestring Event type to disconnect from.
funcNexusHoratio.base.Dispatcher~Handler Function to remove.
Returns
Details
-
attrText( attr, value ) → {NexusHoratio.widget.Widget}
-
Description
Helper that sets an attribute to value.
If value is null, the attribute is removed.
Parameters
Name Type Attributes Description attrstring Name of the attribute.
valuestring <nullable> Value to assign.
Returns
Examples
w.attrText('aria-label', 'Information about the application.')Details
-
attrElements( attr, ...values ) → {NexusHoratio.widget.Widget}
-
Description
Helper that sets an attribute to space separated
Elementids.This will collect the appropriate id from each value passed then assign that collection to the attribute. If any value is null, the everything up to that point will be reset. If the collection ends up being empty (e.g., no values were passed or the last was null), the attribute will be removed.
Parameters
Name Type Attributes Description attrstring Name of the attribute.
valuesNexusHoratio.widget~Content <nullable>
<repeatable>Value to assign.
Returns
Details
-
installStyle( id, rules ) → {external:HTMLStyleElement}
-
Description
Install a style if not already present.
It will NOT overwrite an existing one.
Parameters
Name Type Description idstring Base to use for the style id.
rulesArray.<string> CSS rules in 'selector { declarations }'.
Returns
Details
-
defaultClassesFunc() → {Array.<string>}
-
Description
The default implementation sets no classes.
Returns
Details
-
set( array ) → {NexusHoratio.widget.Grid}
-
Parameters
Name Type Description arrayArray.<object> Data used by the Grid.
Returns
Details
-
rowClassesFunc( func ) → {NexusHoratio.widget.Grid}
-
Description
Sets the function used to style a row.
If no value is passed, it will set the default function.
Parameters
Name Type Description funcNexusHoratio.widget.Grid~RowClassesFunc Styling function.
Returns
Details
Type Definitions
-
GridRecord
-
Description
Arbitrary object to be used as data for
Grid.Details
-
RowClassesFunc( record ) → {Array.<string>}
-
Parameters
Name Type Description recordNexusHoratio.widget.Grid~GridRecord Record to style.
Returns
Details
Events
-
build
-
Details
-
built
-
Details
-
verify
-
Details
-
verified
-
Details
-
destroy
-
Details
-
destroyed
-
Details
-
show
-
Details
-
showed
-
Details
-
hide
-
Details
-
hidden
-
Details