fContextMatch interface

FOM Reference > Content > Format Controls > fContextMatch interface

The context match to test, along with the possible set of actions to perform when the context has been matched. This represents the "match" keyword in the Context control stream, along with all other keywords that define the actions that apply to the match.

apply attribute

If set, the specified set of contexts will be tested to find an appropriate match when this context match is chosen for both enter and exit conditions. This property overrides both onEnter and onExit if also set on this match.

apply
Access	read-write
Returns	fContexts

id attribute

A name that identifies this particular context match to allow it to be selected manually during formatting.

id
Access	read-write
Returns	String

match attribute

A location path identifying the set of nodes for which this context should be processed.

match
Access	read-write
Returns	String

namespaces attribute

A set of XML namespaces and their associated prefixes, used to resolve any namespaces used by the match.

namespaces
Access	read-write
Returns	fStringArray

onEnter attribute

A fStream or JavaScript function that will be formatted when entering the context matched by this item.

onEnter
Access	read-write
Returns	Object

onExit attribute

A fStream or JavaScript function that will be formatted when leaving the context matched by this item.

onExit
Access	read-write
Returns	Object

priority attribute

The priority of the match, to help determine which is the most specific test out of the contexts available.

priority
Access	read-write
Returns	float

fContextMatch method

Creates a new fContextMatch object.

fContextMatch
Parameters	None
Returns	fContextMatch. The newly created object.

readResolve method

Return the object corresponding to the given serialized representation.

readResolveobj
Parameters	Objectobj The serialized representation.
Returns	fContextMatch. The object corresponding to the serialized representation.