1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.accessibility;
import java.util.Locale;
import org.xml.sax.Attributes;
/**
* Receive notifications relating to the structure tree of an FO document.
* A structure tree is a reduced version of the document's FO tree, containing only the logical
* structure that is used by accessible output formats.
*/
public interface StructureTreeEventHandler {
/**
* Starts a page sequence structure tree node.
*
* @param locale The locale of the page sequence
* @param role the value of the role property. May be null.
*/
void startPageSequence(Locale locale, String role);
/**
* Starts a structure tree node.
*
* @param name the name of the structure tree node
* @param attributes the node properties
* @param parent the parent of the node. May be null, in which case the parent node is
* the node corresponding to the previous call to this method
* @return the corresponding structure tree element
*/
StructureTreeElement startNode(String name, Attributes attributes, StructureTreeElement parent);
/**
* Ends a structure tree node.
*
* @param name the name of the structure tree node
*/
void endNode(String name);
/**
* Starts an image node.
*
* @param name the name of the structure tree node
* @param attributes the node properties
* @param parent the parent of the node. May be null, in which case the parent node is
* the node corresponding to the previous call to this method
* @return the corresponding structure tree element
*/
StructureTreeElement startImageNode(String name, Attributes attributes, StructureTreeElement parent);
/**
* Starts a node that can be referenced by other nodes. This is usually a
* node that can have Marked Content References as children.
*
* @param name the name of the structure tree node
* @param attributes the node properties
* @param parent the parent of the node. May be null, in which case the parent node is
* the node corresponding to the previous call to this method
* @return the corresponding structure tree element
*/
StructureTreeElement startReferencedNode(String name, Attributes attributes, StructureTreeElement parent);
/**
* Ends a page sequence structure tree node.
*/
void endPageSequence();
}
|
