New Framework and Renderer functionality: need documentation?

[Antranig Basman]

Thanks, Anastasia - I've replied inline where there are any changes or 
additions needed

On 24/05/2011 18:53, Cheetham, Anastasia wrote:
>
> I'm putting together an overview of new functionality and functions present in the Framework and Renderer that currently don't have documentation (or have inadequate docs), and I'm assuming need it for 1.4. I'd appreciate a review of this list to see if
>    a) I've missed anything, or
>    b) I've included anything that should not be documented yet (or at all)
>
>
> Functionality
> -------------
>
> static environment
> model transformation
> progressive enhancement
> instantiators
> event priorities
Also, component priorities (these use the same set of values as event 
priorities)
> extensions to model accessors (now accepting JSON)
> changes to produceTree configuration
> renderOnInit configuration flag
> new handling of decorators, including
> 	clearDecorators()
> 	visitDecorators()
also getDecoratorComponents() which is probably more useful

> protoTree expansion (current docs incomplete)
> 	slight change of semantic with the "deferredFetcher" expander
Including both repetition and condition expander
> support for contextual reference {styles} in renderer trees
These are not really supported - clarity is needed here that {} 
references in renderer trees only refer to RENDERER variables, of the 
kind instantiated by the repeating expander. If IoC references are 
required, this must be done via demands or defaults blocks as before.

> downgrading rendererComponent to non-ioc via configuration

* A page is needed on "pseudoarguments" and explaining both how to use 
them, and how to define them using the "argumentMap" option.

* A page on fluid.fetchResources, as well as the use of "fetchClass" to 
enable "Proleptic Joinsets"

* A page explaining the kind of logging you (currently) get from IoC if 
you enable it, as well as the "extended stack traces" would probably be 
helpful

* A page on the use of "mergeOptions" and "mergeAllOptions" for giving 
fine-grained policy on the merge priority of options contributed via 
demands, defaults and direct arguments as well as any combinations thereof

> Specific Functions
> ------------------
>
> Fluid.js:
> fluid.applyHostFunction
This should be non-API
> fluid.filterKeys
> fluid.censorKeys
> fluid.clearLifecycleFunctions
Non-API
> fluid.checkTryCatchParameter
Non-API
> fluid.composePath
> fluid.contains
> fluid.event.addListenerToFirer
> fluid.event.getEventFirer
> fluid.event.listenerComparator
Non-API
> fluid.event.mapPriority
Non-API
> fluid.event.sortListeners
Non-API
> fluid.expectFilledSelector
Non-API
> fluid.hasGrade
> fluid.identity
> fluid.initDomBinder
> fluid.isDOMNode
> fluid.isLogging
> fluid.isValue
> fluid.findKeyInObject
> fluid.keyForValue
> fluid.keys
> fluid.makeArray
> fluid.makeComponent
> fluid.makeComponents
> fluid.mergeListeners
non-API
> fluid.mergeListenersPolicy
non-API
> fluid.mergePolicyIs
non-API
> fluid.model.copyModel
> fluid.model.defaultCreatorStrategy
> fluid.model.defaultFetchStrategy
> fluid.model.defaultGetConfig
> fluid.model.defaultSetConfig
> fluid.model.environmentStrategy
> fluid.model.funcResolverStrategy
> fluid.model.getPenultimate
> fluid.model.parseEL
> fluid.tryCatch
> fluid.notrycatch
> fluid.path
> fluid.composePath
> fluid.preInitModelComponent
> fluid.pushSoftFailure
> fluid.registerGlobalFunction
> fluid.setGlobalValue
> fluid.renderTimestamp
> fluid.rootMergePolicy
non-API
> fluid.typeFount
> fluid.typeTag
> fluid.VALUE
> fluid.NO_VALUE
> fluid.EXPAND
non_API
> fluid.EXPAND_NOW
non-API
>
> FluidDocument.js:
> fluid.enabled
> fluid.getLastFocusedElement
> fluid.getScopedData, fluid.setScopedData
> fluid.initEnablement
>
> DataBinding.js:
> fluid.attachModel
> fluid.findData
> fluid.findForm
> fluid.makeSuperApplier
> fluid.model.isNullChange
> fluid.model.mergeModel
> fluid.pathUtil.*
> fluid.value
>
> FluidDOMUtilities.js:
All of FluidDOMUtilities should be considered non-API
> fluid.dom.getElementText
> fluid.dom.isContainer
> fluid.dom.iterateDom
>
> FluidView.js:
> fluid.ariaLabeller
> fluid.ariaLabeller.generateLiveElement
> fluid.deadMansBlur
> fluid.getAriaLabeller
> fluid.updateAriaLabeller
>
> FluidRequests.js:
> fluid.expander.deferredFetcher
> fluid.expander.makeFetchExpander
> fluid.fetchResources
> fluid.fetchResources.clearResourceCache
> fluid.fetchResources.fetchResourcesImpl
non-API
> fluid.fetchResources.primeCacheFromResources
>
> FluidIoC.js:
> fluid.alias
This has dubious status... we had an IRC chat about this but I can't 
remember what we decided
> fluid.deferredCall
> fluid.deferredInvokeCall
> fluid.expander.deferredCall
> fluid.expander.noexpand
> fluid.expandOptions
> fluid.fetchContextReference
> fluid.freeInstantiator
non-API
> fluid.locateTransformationRecord
non-API
> fluid.makeFreeInvoker
> fluid.makeInvoker
> fluid.noexpand
> fluid.parseContextReference
> fluid.renderContextReference
> fluid.resolveEnvironment
> fluid.singleThreadLocal
> fluid.staticEnvironment
> fluid.staticEnvironment.environmentClass
> fluid.threadLocal
>
> fluidRenderer.js:
> fluid.explode
> fluid.explodeSelectionToInputs
> fluid.extractTemplate
> fluid.NULL_STRING
> fluid.render
> fluid.renderer
> fluid.renderTemplates
> fluid.reRender
> fluid.resolveMessageSource
> fluid.selfRender
>
> RendererUtilities.js:
> fluid.renderer.clearDecorators
> fluid.renderer.getDecoratorComponents
> fluid.renderer.visitDecorators
> fluid.renderer.condition
> fluid.renderer.makeProtoExpander
> fluid.renderer.mergeComponents
> fluid.renderer.modeliseOptions
non-API
> fluid.renderer.NO_COMPONENT
non-API
> fluid.renderer.repeat
> fluid.renderer.reverseMerge
non-API
> fluid.renderer.selection.inputs
> fluid.renderer.selectorsToCutpoints
>
>
> FluidDebugging.js:
> fluid.decodeStack
> fluid.detectStackStyle
> fluid.dumpEl
> fluid.exceptionDecoders.firefox
> fluid.getCallerInfo
> fluid.obtainException
> fluid.prettyPrintJSON
> fluid.renderTimestamp
>
>
>