Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

fluid.accumulate(list, fn, arg)


Scan through a list of objects, "accumulating" a value over them (may be a straightforward "sum" or some other chained computation). The results will be added to the initial value passed in by "arg" and returned.

  • list {Array}: The list of objects to be accumulated over
  • fn {Function}: An "accumulation function" accepting the signature (object, total, index) where object is the list member, total is the "running total" object (which is the return value form the previous function), and index is the index number.
  • arg {Object}: The initial value for the "running total" object

Return: arg

fluid.allocateSimpleId(element)


Allocate an id to the supplied element if it has none already, by a simple scheme resulting in ids "fluid-id-nnnn" where nnnn is an increasing integer.

  • element {Element}: The element to place the simple id.

Return: String (representing the id)

Anchor
fluid.byId
fluid.byId

fluid.byId(id, dokkument)


Returns a DOM element quickly, given an id.

  • id {Object}: The id of the DOM node to find
  • dokkument {Document}: the document in which it is to be found (if left empty, use the current document)

Return: Element or null if none exists

See also: fluid.jById

fluid.clear(target)


Clears an object or array of its contents. For objects, each property is deleted.

  • target {Object|Array}: Either an object or an array whose contents you wish to clear

Anchor
fluid.COMPONENT_OPTIONS
fluid.COMPONENT_OPTIONS

fluid.COMPONENT_OPTIONS


A special "marker object" which is recognized as one of the arguments to fluid.initSubComponents. This object is recognized by reference equality - where it is found, it is replaced in the actual argument position supplied to the specific subcomponent instance, with the particular options block for that instance attached to the overall "that" object.

Constant: {}

See also: fluid.initSubComponents

fluid.container(containerSpec)


Fetches a single container element and returns it as a jQuery.

  • containerSpec {String|jQuery|Element}

Return: jQuery (a single-element jQuery of container)

fluid.copy(tocopy)


Performs a deep copy (clone) of its argument

  • tocopy {Object}: the object to be copied

Return: Object (the copy)

fluid.createDomBinder(container, selectors)


Creates a new DOM Binder instance, used to locate elements in the DOM by name.

  • container {Object}: The root element in which to locate named elements
  • selectors {Object}: A collection of named jQuery selectors

Return: Object

See: Markup Configuration and Selectors

fluid.defaults()


Retrieves and stores a component's default settings centrally.

  • {Boolean}: (optional) if true, manipulate a global option (for the head component) rather than instance options
  • {String}: componentName the name of the component
  • {Object}: (optional) a container of key/value pairs to set

Return: Object (If the object is passed in the argument, this is added to the store and then returned. If not, the current object in the store is returned)

See: Markup Configuration and Selectors, Fluid Component API

fluid.dumpEl(element)


Dumps a DOM element into a readily recognizable form for debugging - produces a "semi-selector" summarizing its tag name, class and id, whichever are set.

  • element {jQueryable}: can be an element, selector, function that returns an element, or a jQuery.

Return: String representing the DOM element

fluid.emptySubcomponent(options)


Construct a dummy or "placeholder" subcomponent, that optionally provides empty implementations for a set of methods.

  • options {Anything}: can be anything, will use jQuery.makeArray to turn it into an array

Return: Object (the empty sub-component)

fluid.event.getEventFirer(unicast, preventable)


Constructs an "event firer" object which can be used to register and unregister listeners, to which "events" can be fired. These events consist of an arbitrary function signature.

  • unicast {Boolean}: If true, this is a "unicast" event which may only accept a single listener.
  • preventable {Boolean}: If true, the return value of each handler will be checked for false in which case further listeners will be short circuited, and this will be the return value of fire().

Returns: Object (see below)

Code Block
javascript
javascript
{
    addListener: function(listener, namespace, exclusions),
    removeListener: function(listener),
    fire: function()
}

See: The Fluid Event System

fluid.expectFilledSelector(result, message)


Expect that an output from the DOM binder has resulted in a non-empty set of results. If none are found this function will fail with a diagnostic message, with the supplied message prepended.

  • result {jQuery}: The return value from the DOM Binder
  • message {String}: message to report if the results are empty

fluid.fail(message)


Causes an error message to be logged to the console and a real runtime error to be thrown.

  • message {String|Error}: The error message to log

fluid.find(list, fn, deflt)


Scan through a list of objects, terminating on and returning the first member which matches a predicate function.

  • list {Array}: The list of objects to be searched
  • fn {Function}: A predicate function, acting on a list member. A predicate which returns any value which is not null or undefined will terminate the search. The function accepts (object, index).
  • deflt {Object}: A value to be returned in the case no predicate function matches a list member. The default will be the natural value of undefined.

Return: Object (the first object in the list that matches the predicate function, or deflt if nothing does)

fluid.findAncestor(element, test)


Finds the nearest ancestor of the element that passes the test.

  • element {Element}: DOM element
  • test {Function}: A function which takes an element as a parameter and returns true or false for some test

Anchor
fluid.findKeyInObject
fluid.findKeyInObject

fluid.findKeyInObject


Deprecated

See: fluid.keyForValue

fluid.formatMessage(messageString, args)


Expand a message string with respect to a set of arguments, following a basic subset of the Java Message Format rules. http://java.sun.com/j2se/1.4.2/docs/api/java/text/MessageFormat.html

The message string is expected to contain replacement specifications such as {0}, {1}, {2}, etc.

  • messageString {String}: The message key to be expanded
  • args {String|Array of Strings}: An array of arguments to be substituted into the message.

Return: String (the formatted String)

fluid.getId(element)


Returns the id attribute from a jQuery or pure DOM element

  • element {jQuery|Element}: The element to return the id attribute for

Return: String representing the id

fluid.initDomBinder(that)


Creates a new DOM Binder instance for the specified component and mixes it in.

  • that {Object}: the component instance to attach the new DOM Binder to

See: Markup Configuration and Selectors

{anchor: fluid.initSubcomponent

fluid.initSubcomponent(that, className, args)


This function provides a generic way of instantiating and configuring any "sub-components" that may be a part of, or used by, a parent component. For example, this function is used by the Inline Edit component to instantiate the Undo decorator, a sub-component that provides Undo functionality to components that support it.

  • that {Component}: the top-level component for which sub-components are to be instantiated. It contains specifications for these sub-components in its options structure.
  • className {String}: The "class name" or "category" for the sub-components to be instantiated. A class name specifies an overall "function" for a class of sub-components and represents a category which accept the name signature of instantiation arguments.
  • args {Array of Object}: The instantiation arguments to be passed to each constructed sub-component. These will typically be members derived from the top-level "that" or perhaps globally discovered from elsewhere. One of theses arguments may be fluid.COMPONENT_OPTIONS in which case this placeholder argument will be replaced by instance specific options configured into the member of the top-level options structure named for the className.

Return Component (a single component)

See: Subcomponents, fluid.initSubcomponents

Anchor
fluid.initSubcomponents
fluid.initSubcomponents

fluid.initSubcomponents


Initialize all the "sub-components" which are configured to be attached to the supplied top-level component, which share a particular "class name".

  • that {Component}: the top-level component for which sub-components are to be instantiated. It contains specifications for these sub-components in its options structure.
  • className {String}: The "class name" or "category" for the sub-components to be instantiated. A class name specifies an overall "function" for a class of sub-components and represents a category which accept the name signature of instantiation arguments.
  • args {Array of Object}: The instantiation arguments to be passed to each constructed sub-component. These will typically be members derived from the top-level "that" or perhaps globally discovered from elsewhere. One of theses arguments may be fluid.COMPONENT_OPTIONS in which case this placeholder argument will be replaced by instance specific options configured into the member of the top-level options structure named for the className.

Return: Array of sub-components

See also: fluid.COMPONENT_OPTIONS, fluid.initSubcomponent

fluid.initView(componentName, container, userOptions)


The central initialization method called as the first act of every Fluid component. This function automatically merges user options with defaults, attaches a DOM Binder to the instance, and configures events.

  • componentName {String}: The unique "name" of the component, which will be used to fetch the default options from store. By recommendation, this should be the global name of the component's creator function.
  • container {jQueryable}: A specifier for the single root "container node" in the DOM which will house all the markup for this component. Can be an element, selector, function that returns an element, or a jQuery.
  • userOptions {Object}: The configuration options for this component.

Return: Component

fluid.instantiateFirers(that, options)


Sets up a component's declared events.

Events are specified in the options object by name. There are three different types of events tat can be specified.

  1. An ordinary multicast event, specified by "null"
  2. A unicast event, which allows only one listener to be registered
  3. A preventable event.


  • that {Object}: The component
  • options {Object}: The component's options structure, containing the declared event names and types.

fluid.invokeGlobalFunction(functionPath, args, environment)


  • functionPath {}:
  • args {}:
  • environment {}: An optional "environment" which, if it contains any members at top level, will take priority over the root data structure.

Return:

See also: fluid.model.getBeanValue

fluid.isPrimitive


Anchor
fluid.byId
fluid.byId

fluid.jById


See also: fluid.byId

Anchor
fluid.keyForValue
fluid.keyForValue

fluid.keyForValue


See also: fluid.findKeyInObject

fluid.log


fluid.mergeComponentOptions


fluid.merge


fluid.mergeListeners


fluid.messageLocator


fluid.model.composePath


fluid.model.copyModel


Anchor
fluid.model.getBeanValue
fluid.model.getBeanValue

fluid.model.getBeanValue


fluid.remove


fluid.stringTemplate


fluid.transform


Anchor
fluid.unwrap
fluid.unwrap

fluid.unwrap


See also: fluid.wrap

fluid.VALUE


fluid.version


Anchor
fluid.wrap
fluid.wrap

fluid.wrap


See also: fluid.unwrap

fluid.initComponents(that, className, args)

...