org.apache.fop.pdf.PDFJavaScriptLaunchAction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation
Show all versions of fop Show documentation
Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF.
/*
* 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: PDFJavaScriptLaunchAction.java 1616416 2014-08-07 06:46:57Z gadams $ */
package org.apache.fop.pdf;
/**
* PDF Action which executes some JavaScript code.
* @since PDF 1.3
*/
public class PDFJavaScriptLaunchAction extends PDFAction {
private String script;
/**
* Creates a new /Launch action.
* @param script the script to run when the launch action is triggered
*/
public PDFJavaScriptLaunchAction(String script) {
this.script = script;
}
/** {@inheritDoc} */
public String getAction() {
return this.referencePDF();
}
/** {@inheritDoc} */
public String toPDFString() {
StringBuffer sb = new StringBuffer(64);
sb.append("<<\n/S /JavaScript\n/JS (");
sb.append(this.script);
sb.append(")\n>>");
return sb.toString();
}
/** {@inheritDoc} */
protected boolean contentEquals(PDFObject obj) {
if (this == obj) {
return true;
}
if (obj == null || !(obj instanceof PDFJavaScriptLaunchAction)) {
return false;
}
PDFJavaScriptLaunchAction launch = (PDFJavaScriptLaunchAction) obj;
if (!launch.script.equals(script)) {
return false;
}
return true;
}
}