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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright 2005 The Apache Software Foundation.
*
* Licensed 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.fo.pagination.bookmarks;
import java.util.ArrayList;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.properties.CommonAccessibility;
/**
* The fo:bookmark formatting object, first introduced in the
* XSL 1.1 WD. Prototype version only, subject to change as
* XSL 1.1 WD evolves.
*/
public class Bookmark extends FObj {
private BookmarkTitle bookmarkTitle;
private ArrayList childBookmarks = new ArrayList();
// The value of properties relevant for this FO
private CommonAccessibility commonAccessibility;
private String internalDestination;
private String externalDestination;
private boolean bShow = true; // from starting-state property
/**
* Create a new bookmark object.
*
* @param parent the parent fo node
*/
public Bookmark(FONode parent) {
super(parent);
}
/**
* @see org.apache.fop.fo.FObj#bind(PropertyList)
*/
public void bind(PropertyList pList) throws FOPException {
commonAccessibility = pList.getAccessibilityProps();
externalDestination = pList.get(PR_EXTERNAL_DESTINATION).getString();
internalDestination = pList.get(PR_INTERNAL_DESTINATION).getString();
bShow = (pList.get(PR_STARTING_STATE).getEnum() == EN_SHOW);
// per spec, internal takes precedence if both specified
if (internalDestination.length() > 0) {
externalDestination = null;
} else if (externalDestination.length() == 0) {
// slightly stronger than spec "should be specified"
attributeError("Missing attribute: Either external-destination or " +
"internal-destination must be specified.");
} else {
attributeWarning("external-destination property not currently supported");
}
}
/**
* @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String)
XSL/FOP: (bookmark-title, bookmark*)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (nsURI == FO_URI && localName.equals("bookmark-title")) {
if (bookmarkTitle != null) {
tooManyNodesError(loc, "fo:bookmark-title");
}
} else if (nsURI == FO_URI && localName.equals("bookmark")) {
if (bookmarkTitle == null) {
nodesOutOfOrderError(loc, "fo:bookmark-title", "fo:bookmark");
}
} else {
invalidChildError(loc, nsURI, localName);
}
}
/**
* @see org.apache.fop.fo.FONode#endOfNode
*/
protected void endOfNode() throws FOPException {
if (bookmarkTitle == null) {
missingChildElementError("(bookmark-title, bookmark*)");
}
}
/**
* @see org.apache.fop.fo.FONode#addChildNode(FONode)
*/
protected void addChildNode(FONode obj) {
if (obj instanceof BookmarkTitle) {
bookmarkTitle = (BookmarkTitle)obj;
} else if (obj instanceof Bookmark) {
childBookmarks.add(obj);
}
}
/**
* Get the bookmark title for this bookmark
*
* @return the bookmark title string or an empty string if not found
*/
public String getBookmarkTitle() {
return bookmarkTitle == null ? "" : bookmarkTitle.getTitle();
}
public String getInternalDestination() {
return internalDestination;
}
public String getExternalDestination() {
return externalDestination;
}
/**
* Determines if this fo:bookmark's subitems should be initially displayed
* or hidden, based on the starting-state property set on this FO.
*
* @return true if this bookmark's starting-state is "show", false if "hide".
*/
public boolean showChildItems() {
return bShow;
}
public ArrayList getChildBookmarks() {
return childBookmarks;
}
/**
* @see org.apache.fop.fo.FObj#getName()
*/
public String getName() {
return "fo:bookmark";
}
/**
* @see org.apache.fop.fo.FObj#getNameId()
*/
public int getNameId() {
return FO_BOOKMARK;
}
}
|
