123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200 |
- /*
- * $Id$
- * Copyright (C) 2001-2002 The Apache Software Foundation. All rights reserved.
- * For details on use and redistribution please refer to the
- * LICENSE file included with these sources.
- */
-
- package org.apache.fop.area;
-
- import java.io.Serializable;
-
- import java.util.HashMap;
-
- // If the area appears more than once in the output
- // or if the area has external data it is cached
- // to keep track of it and to minimize rendered output
- // renderers can render the output once and display it
- // for every occurence
- // this should also extend to all outputs (including PDFGraphics2D)
- // and all types of renderers
-
- /**
- * Base object for all areas.
- */
- public class Area implements Serializable {
- // stacking directions
- /**
- * Stacking left to right
- */
- public static final int LR = 0;
-
- /**
- * Stacking right to left
- */
- public static final int RL = 1;
-
- /**
- * Stacking top to bottom
- */
- public static final int TB = 2;
-
- /**
- * Stacking bottom to top
- */
- public static final int BT = 3;
-
- // orientations for reference areas
- /**
- * Normal orientation
- */
- public static final int ORIENT_0 = 0;
-
- /**
- * Rotated 90 degrees clockwise
- */
- public static final int ORIENT_90 = 1;
-
- /**
- * Rotate 180 degrees
- */
- public static final int ORIENT_180 = 2;
-
- /**
- * Rotated 270 degrees clockwise
- */
- public static final int ORIENT_270 = 3;
-
- // area class values
-
- /**
- * Normal class
- */
- public static final int CLASS_NORMAL = 0;
-
- /**
- * Fixed position class
- */
- public static final int CLASS_FIXED = 1;
-
- /**
- * Absolute position class
- */
- public static final int CLASS_ABSOLUTE = 2;
-
- /**
- * Before float class
- */
- public static final int CLASS_BEFORE_FLOAT = 3;
-
- /**
- * Footnote class
- */
- public static final int CLASS_FOOTNOTE = 4;
-
- /**
- * Side float class
- */
- public static final int CLASS_SIDE_FLOAT = 5;
-
- // IMPORTANT: make sure this is the maximum + 1
- /**
- * Maximum class count
- */
- public static final int CLASS_MAX = CLASS_SIDE_FLOAT + 1;
-
- private int areaClass = CLASS_NORMAL;
- private int ipd;
- private HashMap props = null;
-
- /**
- * Get the area class of this area.
- *
- * @return the area class
- */
- public int getAreaClass() {
- return areaClass;
- }
-
- /**
- * Set the area class of this area.
- *
- * @param areaClass the area class
- */
- public void setAreaClass(int areaClass) {
- this.areaClass = areaClass;
- }
-
- /**
- * Set the inline progression dimension of this area.
- *
- * @param i the new inline progression dimension
- */
- public void setIPD(int i) {
- ipd = i;
- }
-
- /**
- * Get the inline progression dimension of this area.
- *
- * @return the inline progression dimension
- */
- public int getIPD() {
- return ipd;
- }
-
- /**
- * Add a child to this area.
- * The default is to do nothing. Subclasses must override
- * to do something if they can have child areas.
- *
- * @param child the child area to add
- */
- public void addChild(Area child) {
- }
-
- /**
- * Add a trait property to this area.
- *
- * @param prop the Trait to add
- */
- public void addTrait(Trait prop) {
- if (props == null) {
- props = new HashMap(20);
- }
- props.put(prop.propType, prop.data);
- }
-
- /**
- * Add a trait to this area.
- *
- * @param traitCode the trait key
- * @param prop the value of the trait
- */
- public void addTrait(Object traitCode, Object prop) {
- if (props == null) {
- props = new HashMap(20);
- }
- props.put(traitCode, prop);
- }
-
- /**
- * Get the map of all traits on this area.
- *
- * @return the map of traits
- */
- public HashMap getTraits() {
- return this.props;
- }
-
- /**
- * Get a trait from this area.
- *
- * @param oTraitCode the trait key
- * @return the trait value
- */
- public Object getTrait(Object oTraitCode) {
- return (props != null ? props.get(oTraitCode) : null);
- }
- }
|