org.apache.fop.fo.pagination.bookmarks.BookmarkTitle Maven / Gradle / Ivy
/*
* 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.fo.pagination.bookmarks;
import org.xml.sax.Locator;
import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.properties.CommonAccessibility;
import org.apache.fop.fo.properties.CommonAccessibilityHolder;
/**
* Class modelling the
* fo:bookmark-title object, first introduced in the
* XSL 1.1 WD.
*/
public class BookmarkTitle extends FObj implements CommonAccessibilityHolder {
private CommonAccessibility commonAccessibility;
private String title = "";
/**
* Create a new BookmarkTitle object that is a child
* of the given {@link FONode}.
*
* @param parent the {@link FONode} parent
*/
public BookmarkTitle(FONode parent) {
super(parent);
}
@Override
public void bind(PropertyList pList) throws FOPException {
super.bind(pList);
commonAccessibility = CommonAccessibility.getInstance(pList);
}
/**
* Add the characters to this BookmarkTitle.
* The text data inside the BookmarkTitle xml element
* is used for the BookmarkTitle string.
*
* @param data the character data
* @param start the start position in the data array
* @param length the length of the character array
* @param pList currently applicable PropertyList
* @param locator location in fo source file.
*/
protected void characters(char[] data, int start, int length,
PropertyList pList,
Locator locator) {
title += new String(data, start, length);
}
/**
* {@inheritDoc}
*
XSL/FOP: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
invalidChildError(loc, nsURI, localName);
}
}
/** {@inheritDoc} */
public CommonAccessibility getCommonAccessibility() {
return commonAccessibility;
}
/**
* Get the title for this BookmarkTitle.
*
* @return the bookmark title
*/
public String getTitle() {
return title;
}
/** {@inheritDoc} */
public String getLocalName() {
return "bookmark-title";
}
/**
* {@inheritDoc}
* @return {@link org.apache.fop.fo.Constants#FO_BOOKMARK_TITLE}
*/
public int getNameId() {
return FO_BOOKMARK_TITLE;
}
}