git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@355471 13f79535-47bb-0310-9956-ffa450edef68tags/fop-0_91-beta
* Note that this class can only find the version information if it's in the org.apache.fop package | * Note that this class can only find the version information if it's in the org.apache.fop package | ||||
* as this package equals the one specified in the manifest. | * as this package equals the one specified in the manifest. | ||||
*/ | */ | ||||
public class Version { | |||||
public final class Version { | |||||
private Version() { } | |||||
/** | /** | ||||
* Get the version of FOP | * Get the version of FOP |
/** | /** | ||||
* Constructs a new FOP exception with the specified detail message and location. | * Constructs a new FOP exception with the specified detail message and location. | ||||
* @param message the detail message | * @param message the detail message | ||||
* @param systemId the system id of the FO document which is associated with the exception. May be null. | |||||
* @param systemId the system id of the FO document which is associated with the exception | |||||
* may be null. | |||||
* @param line line number in the FO document which is associated with the exception. | * @param line line number in the FO document which is associated with the exception. | ||||
* @param column clolumn number in the line which is associated with the exception. | * @param column clolumn number in the line which is associated with the exception. | ||||
*/ | */ | ||||
/** | /** | ||||
* Set a location associated with the exception. | * Set a location associated with the exception. | ||||
* @param systemId the system id of the FO document which is associated with the exception. May be null. | |||||
* @param systemId the system id of the FO document which is associated with the exception; | |||||
* may be null. | |||||
* @param line line number in the FO document which is associated with the exception. | * @param line line number in the FO document which is associated with the exception. | ||||
* @param column clolumn number in the line which is associated with the exception. | * @param column clolumn number in the line which is associated with the exception. | ||||
*/ | */ | ||||
/** | /** | ||||
* Indicate whether a location was set. | * Indicate whether a location was set. | ||||
* @return whether a location was set | |||||
*/ | */ | ||||
public boolean isLocationSet() { | public boolean isLocationSet() { | ||||
// TODO: this is actually a dangerous assumption: A line | // TODO: this is actually a dangerous assumption: A line | ||||
* SystemId:LL:CC: &the message& | * SystemId:LL:CC: &the message& | ||||
* </pre> | * </pre> | ||||
* (the format used by most GNU tools) | * (the format used by most GNU tools) | ||||
* @return the detail message string of this FOP exception | |||||
*/ | */ | ||||
public String getMessage() { | public String getMessage() { | ||||
if (isLocationSet()) { | if (isLocationSet()) { |
* output format (ex. "application/pdf" for PDF). | * output format (ex. "application/pdf" for PDF). | ||||
* @param outputFormat the MIME type of the output format to use (ex. "application/pdf"). | * @param outputFormat the MIME type of the output format to use (ex. "application/pdf"). | ||||
* @param ua FOUserAgent object | * @param ua FOUserAgent object | ||||
* @throws IllegalArgumentException if an unsupported renderer type was requested. | |||||
*/ | */ | ||||
public Fop(String outputFormat, FOUserAgent ua) { | public Fop(String outputFormat, FOUserAgent ua) { | ||||
this.outputFormat = outputFormat; | this.outputFormat = outputFormat; | ||||
* Constructor for FOP with a default FOUserAgent. It uses MIME types to select the | * Constructor for FOP with a default FOUserAgent. It uses MIME types to select the | ||||
* output format (ex. "application/pdf" for PDF). | * output format (ex. "application/pdf" for PDF). | ||||
* @param outputFormat the MIME type of the output format to use (ex. "application/pdf"). | * @param outputFormat the MIME type of the output format to use (ex. "application/pdf"). | ||||
* @throws IllegalArgumentException if an unsupported renderer type was requested. | |||||
*/ | */ | ||||
public Fop(String outputFormat) { | public Fop(String outputFormat) { | ||||
this(outputFormat, null); | this(outputFormat, null); | ||||
* <li>Fop.RENDER_PNG</li> | * <li>Fop.RENDER_PNG</li> | ||||
* </ul> | * </ul> | ||||
* @param ua FOUserAgent object | * @param ua FOUserAgent object | ||||
* @throws IllegalArgumentException if an unsupported renderer type was requested. | |||||
* @deprecated Use {@link org.apache.fop.apps.Fop#Fop(java.lang.String, FOUserAgent)} instead! | * @deprecated Use {@link org.apache.fop.apps.Fop#Fop(java.lang.String, FOUserAgent)} instead! | ||||
* This constructor will be removed. | * This constructor will be removed. | ||||
*/ | */ |
/** | /** | ||||
* Perform a shallow cloning operation, | * Perform a shallow cloning operation, | ||||
* set its parent, and optionally clean the list of child nodes | * set its parent, and optionally clean the list of child nodes | ||||
* @param parent the intended parent of the clone | |||||
* @param cloneparent the intended parent of the clone | |||||
* @param removeChildren if true, clean the list of child nodes | * @param removeChildren if true, clean the list of child nodes | ||||
* @return the cloned FO node | * @return the cloned FO node | ||||
* @throws FOPException if there's a problem while cloning the node | * @throws FOPException if there's a problem while cloning the node | ||||
*/ | */ | ||||
public FONode clone(FONode parent, boolean removeChildren) | |||||
public FONode clone(FONode cloneparent, boolean removeChildren) | |||||
throws FOPException { | throws FOPException { | ||||
FONode foNode = (FONode) clone(); | FONode foNode = (FONode) clone(); | ||||
foNode.parent = parent; | |||||
parent.addChildNode(foNode); | |||||
foNode.parent = cloneparent; | |||||
cloneparent.addChildNode(foNode); | |||||
return foNode; | return foNode; | ||||
} | } | ||||
* @param elementName element name (e.g., "fo:block") | * @param elementName element name (e.g., "fo:block") | ||||
* @param locator Locator object (ignored by default) | * @param locator Locator object (ignored by default) | ||||
* @param attlist Collection of attributes passed to us from the parser. | * @param attlist Collection of attributes passed to us from the parser. | ||||
* @param parent the property list of the parent node | |||||
* @param pList the property list of the parent node | |||||
* @throws FOPException for errors or inconsistencies in the attributes | * @throws FOPException for errors or inconsistencies in the attributes | ||||
*/ | */ | ||||
public void processNode(String elementName, Locator locator, | public void processNode(String elementName, Locator locator, | ||||
Attributes attlist, PropertyList parent) throws FOPException { | |||||
Attributes attlist, PropertyList pList) throws FOPException { | |||||
if (log.isDebugEnabled()) { | if (log.isDebugEnabled()) { | ||||
log.debug("Unhandled element: " + elementName | log.debug("Unhandled element: " + elementName | ||||
+ (locator != null ? " at " + getLocatorString(locator) : "")); | + (locator != null ? " at " + getLocatorString(locator) : "")); | ||||
/** | /** | ||||
* Create a property list for this node. Return null if the node does not | * Create a property list for this node. Return null if the node does not | ||||
* need a property list. | * need a property list. | ||||
* @param parent the closest parent propertylist. | |||||
* @param pList the closest parent propertylist. | |||||
* @param foEventHandler The FOEventHandler where the PropertyListMaker | * @param foEventHandler The FOEventHandler where the PropertyListMaker | ||||
* instance can be found. | * instance can be found. | ||||
* @return A new property list. | * @return A new property list. | ||||
* @throws FOPException if there's a problem during processing | * @throws FOPException if there's a problem during processing | ||||
*/ | */ | ||||
protected PropertyList createPropertyList(PropertyList parent, FOEventHandler foEventHandler) | |||||
protected PropertyList createPropertyList(PropertyList pList, FOEventHandler foEventHandler) | |||||
throws FOPException { | throws FOPException { | ||||
return null; | return null; | ||||
} | } |