Table of contents

Appendices

7.22 Properties for Dynamic Effects Formatting Objects

active-state[top]

XSL Definition:

link

This fo:multi-property-set applies if there is a fo:basic-link descendant of the parent fo:multi-properties and that link has not yet been visited.

visited

This fo:multi-property-set applies if there is a fo:basic-link descendant of the parent fo:multi-properties and that link has been visited.

active

This fo:multi-property-set applies while a normal area returned by the parent fo:multi-properties is being activated by the user. For example, between the times the user presses the mouse button and releases it.

hover

This fo:multi-property-set applies while the user designates a normal area returned by the parent fo:multi-properties (with some pointing device), but does not activate it. For example the cursor (mouse pointer) hovers over such an area.

focus

This fo:multi-property-set applies while a normal area returned by the parent fo:multi-properties has the focus (accepts keyboard events or other forms of text input).

The "active-state" property is used to control which of the fo:multi-property-sets are used to format the child flow objects within an fo:multi-properties formatting object. The states (or at least the events that cause the state to be entered) are defined by the DOM.

auto-restore[top]

XSL Definition:

true

If this fo:multi-switch is contained in another fo:multi-switch, and that fo:multi-switch changes the active fo:multi-case (hiding this fo:multi-switch), then this fo:multi-switch should restore its initial fo:multi-case.

false

This fo:multi-switch should retain its current fo:multi-case.

Specifies if the initial fo:multi-case should be restored when the fo:multi-switch gets hidden by an ancestor fo:multi-switch.

NOTE: 

A common case of using this property with a "true" value is when several nested fo:multi-switch objects build an expandable/collapsible table-of-contents view. If the table-of-contents is expanded far down the hierarchy, and an (far above) ancestor is closed, one would want all subtitles to have restored to their original state when that ancestor is opened again.

case-name[top]

XSL Definition:

<name>

Specifies a name for an fo:multi-case. The name must be unique among the current fo:multi-case siblings, i.e., in the scope of the fo:multi-switch object that (directly) contains them. Other instances of fo:multi-switch objects may use the same names for its fo:multi-case objects.

The purpose of this property is to allow fo:multi-toggle objects to select fo:multi-case objects to switch to.

case-title[top]

XSL Definition:

<string>

Specifies a descriptive title for the fo:multi-case. The title can be displayed in a menu to represent this fo:multi-case when an fo:multi-toggle object names several fo:multi-case objects as allowed destinations.

destination-placement-offset[top]

XSL Definition:

<length>

The "destination-placement-offset" property specifies the distance from the beginning (top) of the page to the innermost line-area that contains the first destination area. If the first destination area is not contained in a line-area, the "destination-placement-offset" property instead directly specifies the distance to the top of the destination area.

If the specification of destination-placement-offset would result in a distance longer than the distance from the start of the document, the distance from the start of the document should be used.

If the specified distance would push the first destination area below the page-area, the distance should be decreased so the whole first destination area becomes visible, if possible. If the first destination area is higher than the page, the top of the area should be aligned with the top of the page.

external-destination[top]

XSL Definition:

<uri-specification>

Specifies the destination resource (or, when a fragment identifier is given, sub-resource) for an fo:basic-link.

How the destination (sub-)resource is used and/or displayed is application and implementation-dependent. In typical browsing applications, the destination resource is displayed in the browser positioned so that some rendered portion resulting from the processing of some part of the specific destination sub-resource indicated by the fragment identifier is in view.

At least one of the external-destination and internal-destination properties should be assigned. If both are assigned, the system may either report the error, or use the internal-destination property.

indicate-destination[top]

XSL Definition:

true

The areas that belong to the link target when traversed should, in a system-dependent manner, be indicated.

false

No special indication should be made.

NOTE: 

This could be indicated in any feasible way, e.g., by reversed video, etc.

internal-destination[top]

XSL Definition:

<idref>

Specifies the destination flow object of an fo:basic-link. This property allows the destination flow object node to be explicitly specified.

At least one of the external-destination and internal-destination properties should be assigned. If both are assigned, the system may either report the error, or use the internal-destination property.

show-destination[top]

XSL Definition:

replace

The current document view should be replaced. However, if the destination area(s) are already available in a page/region, those areas should simply be moved/scrolled "into sight".

new

A new (additional) document view should always be opened.

Specifies where the destination resource should be displayed.

starting-state[top]

XSL Definition:

show

The content of the fo:multi-case is a candidate for being displayed initially.

hide

The content of the fo:multi-case is not a candidate for being displayed initially.

Specifies if the fo:multi-case can be initially displayed.

The parent fo:multi-switch shall choose the first fo:multi-case child where the property "starting-state" has the value equal to "show".

NOTE: 

Any number of the fo:multi-case objects may assign "starting-state" to "show".

If no fo:multi-case has "starting-state" property value of "show", the contents of no fo:multi-case should be displayed.

NOTE: 

If no multi-case is displayed, the entire fo:multi-switch will effectively be hidden.

switch-to[top]

XSL Definition:

xsl-preceding

Activating the switch should result in the current fo:multi-case being replaced by its preceding sibling.

NOTE: 

The current fo:multi-case is the closest ancestor fo:multi-case.

In other words, the current fo:multi-switch should switch to the previous sibling of the fo:multi-case that is currently selected.

NOTE: 

The current fo:multi-switch is the closest ancestor fo:multi-switch.

If the current fo:multi-case is the first sibling, xsl-preceding should switch to the last fo:multi-case sibling.

xsl-following

Activating the switch should result in that the current fo:multi-case is replaced by its next sibling.

If the current fo:multi-case is the last sibling, xsl-following should switch to the first fo:multi-case sibling.

xsl-any

Activating the switch should allow the user to select any other fo:multi-case sibling.

If there is only a single other fo:multi-case, the toggle should immediately switch to it (and not show that single choice to the user).

<name>

A name matching a case-name of an fo:multi-case.

Specifies what fo:multi-case object(s) this fo:multi-toggle shall switch to.

If switch-to is a name list, the user can switch to any of the named multi-case objects. If a multi-toggle with a single name is activated, it should immediately switch to the named multi-case.

NOTE: 

How to actually select the multi-case from a list is system dependent.

target-presentation-context[top]

XSL Definition:

use-target-processing-context

The context specified by the "target-processing-context" property shall be used.

<uri-specification>

Specifies the limited context in which the resource should be presented if the external destination is a resource of a processed structured media type for which a limited presentational context makes sense (e.g., XML, XHTML, SVG).

This property is ignored if the "external-destination" property has an empty string value or if the external destination is not of a processed structured media type for which a limited presentational context makes sense.

NOTE: 

For example, an XML and XSL implementation may parse the XML document, but begin XSLT processing by applying templates to the node set indicated by the "target-presentation-context" property.

NOTE: 

If this is a node other than the document root, numbering and other contextually-dependent presentation may differ between implementations. Some implementations may want to make this tradeoff for memory or performance reasons.

target-processing-context[top]

XSL Definition:

document-root

The root of the document of the external-destination is used.

<uri-specification>

Specifies the root of a virtual document that the processor preparing the new presentation should process if the external destination is a resource of a processed structured media type (e.g., XML, SVG).

This property is ignored if the "external-destination" property has an empty string value or if the external destination is not of a processed structured media type.

NOTE: 

Not all URI references will be sensible roots, e.g., an XPointer that gives a string range into an XML document.

If the root is not valid for the media type the processor may ignore this property.

target-stylesheet[top]

XSL Definition:

use-normal-stylesheet

The implementation will discover stylesheets using its usual methods.

<uri-specification>

Specifies the stylesheet that shall be used for processing the resource. This stylesheet shall be used instead of any other stylesheet that otherwise would be used.

NOTE: 

For example from HTTP header information, XML stylesheet processing instructions, or XHTML style and link elements.

This property is ignored if the "external-destination" property has an empty string value or if the external destination is not of a media type that uses stylesheets.

NOTE: 

In this version of XSL, only a single stylesheet URI reference is permitted. A future version of XSL may extend the stylesheet specification.