* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.fo;
import org.apache.fop.datatypes.LengthPair;
+/**
+ * Superclass for properties wrapping a LengthPair value
+ */
public class LengthPairProperty extends Property {
+ /**
+ * Inner class for creating instances of LengthPairProperty
+ */
public static class Maker extends LengthProperty.Maker {
+ /**
+ * @param name name of property for which this Maker should be created
+ */
protected Maker(String name) {
super(name);
}
private LengthPair lengthPair;
+ /**
+ * @param lengthPair the LengthPair object to be wrapped in this Property
+ */
public LengthPairProperty(LengthPair lengthPair) {
this.lengthPair = lengthPair;
}
+ /**
+ * @return this.lengthPair
+ */
public LengthPair getLengthPair() {
return this.lengthPair;
}
+ /**
+ * @return this.lengthPair cast as an Object
+ */
public Object getObject() {
return this.lengthPair;
}
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.fo;
import org.apache.fop.datatypes.Length;
import org.apache.fop.fo.expr.Numeric;
import org.apache.fop.apps.FOPException;
+/**
+ * Superclass for properties wrapping a Length value.
+ */
public class LengthProperty extends Property {
+ /**
+ * Inner class for making instances of LengthProperty
+ */
public static class Maker extends Property.Maker {
+ /**
+ * @param name name of property for which Maker should be created
+ */
public /* protected */ Maker(String name) {
super(name);
}
* }
*/
+ /**
+ * @return false (auto-length is not allowed for Length values)
+ */
protected boolean isAutoLengthAllowed() {
return false;
}
+ /**
+ * @see Property#convertProperty
+ */
public Property convertProperty(Property p,
PropertyList propertyList,
FObj fo) throws FOPException {
*/
private Length length;
+ /**
+ * @param length Length object to wrap in this
+ */
public LengthProperty(Length length) {
this.length = length;
// System.err.println("Set LengthProperty: " + length.toString());
}
+ /**
+ * @return this.lenght cast as a Numeric
+ */
public Numeric getNumeric() {
return length.asNumeric() ;
}
+ /**
+ * @return this.length
+ */
public Length getLength() {
return this.length;
}
+ /**
+ * @return this.length cast as an Object
+ */
public Object getObject() {
return this.length;
}
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.fo;
import org.apache.fop.datatypes.LengthRange;
+/**
+ * Superclass for properties that contain LengthRange values
+ */
public class LengthRangeProperty extends Property {
+ /**
+ * Inner class for a Maker for LengthProperty objects
+ */
public static class Maker extends LengthProperty.Maker {
+ /**
+ * @param name name of property for which to create Maker
+ */
protected Maker(String name) {
super(name);
}
private LengthRange lengthRange;
+ /**
+ * @param lengthRange LengthRange object to wrap in this
+ */
public LengthRangeProperty(LengthRange lengthRange) {
this.lengthRange = lengthRange;
}
+ /**
+ * @return this.lengthRange
+ */
public LengthRange getLengthRange() {
return this.lengthRange;
}
+ /**
+ * @return this.lengthRange cast as an Object
+ */
public Object getObject() {
return this.lengthRange;
}
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.fo;
import java.util.Vector;
+/**
+ * Superclass for properties that are lists of other properties
+ */
public class ListProperty extends Property {
+ /**
+ * Inner class for creating instances of ListProperty
+ */
public static class Maker extends Property.Maker {
+ /**
+ * @param name name of property for which Maker should be created
+ */
public Maker(String name) {
super(name);
}
+ /**
+ * @see Property#convertProperty
+ */
public Property convertProperty(Property p,
PropertyList propertyList, FObj fo) {
if (p instanceof ListProperty) {
}
+ /** Vector containing the list of sub-properties */
protected Vector list;
+ /**
+ * @param prop the first Property to be added to the list
+ */
public ListProperty(Property prop) {
list = new Vector();
list.addElement(prop);
}
+ /**
+ * Add a new property to the list
+ * @param prop Property to be added to the list
+ */
public void addProperty(Property prop) {
list.addElement(prop);
}
+ /**
+ * @return this.list
+ */
public Vector getList() {
return list;
}
+ /**
+ * @return this.list cast as an Object
+ */
public Object getObject() {
return list;
}
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.fo;
import org.apache.fop.datatypes.ColorType;
import org.apache.fop.fo.expr.Numeric;
+/**
+ * Class for handling numeric properties
+ */
public class NumberProperty extends Property {
+ /**
+ * Inner class for making NumberProperty objects
+ */
public static class Maker extends Property.Maker {
+ /**
+ * Constructor for NumberProperty.Maker
+ * @param propName the name of the property
+ */
public Maker(String propName) {
super(propName);
}
+ /**
+ * @see Property#convertProperty
+ */
public Property convertProperty(Property p,
PropertyList propertyList, FObj fo) {
if (p instanceof NumberProperty) {
private Number number;
+ /**
+ * Constructor for Number input
+ * @param num Number object value for property
+ */
public NumberProperty(Number num) {
this.number = num;
}
+ /**
+ * Constructor for double input
+ * @param num double numeric value for property
+ */
public NumberProperty(double num) {
this.number = new Double(num);
}
+ /**
+ * Constructor for integer input
+ * @param num integer numeric value for property
+ */
public NumberProperty(int num) {
this.number = new Integer(num);
}
+ /**
+ * @return this.number cast as a Number
+ */
public Number getNumber() {
return this.number;
}
* }
*/
+ /**
+ * @return this.number cast as an Object
+ */
public Object getObject() {
return this.number;
}
+ /**
+ * Convert NumberProperty to Numeric object
+ * @return Numeric object corresponding to this
+ */
public Numeric getNumeric() {
return new Numeric(this.number);
}
+ /**
+ * Convert NumberProperty to a ColorType. Not sure why this is needed.
+ * @return ColorType that corresponds to black
+ */
public ColorType getColorType() {
// Convert numeric value to color ???
// Convert to hexadecimal and then try to make it into a color?
projects / xmlgraphics-fop.git / commitdiff