123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255 |
- /*
- * Copyright 1999-2004 The Apache Software Foundation.
- *
- * Licensed 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.layoutmgr;
-
- import java.util.LinkedList;
- import java.util.List;
- import java.util.Map;
-
- import org.apache.fop.fo.flow.Marker;
-
- import org.apache.fop.area.Area;
- import org.apache.fop.area.Resolvable;
- import org.apache.fop.area.PageViewport;
- import org.apache.fop.fo.FObj;
-
- /**
- * The interface for all LayoutManagers.
- */
- public interface LayoutManager {
-
- /**
- * Set the FO object for this layout manager.
- * For layout managers that are created without an FO
- * this may not be called.
- *
- * @param obj the FO object for this layout manager
- */
- void setFObj(FObj obj);
-
- /**
- * Set the parent layout manager.
- * The parent layout manager is required for adding areas.
- *
- * @param lm the parent layout manager
- */
- void setParent(LayoutManager lm);
-
- /**
- * Get the parent layout manager.
- * @return the parent layout manager.
- */
- LayoutManager getParent();
-
- /**
- * Initialize this layout manager.
- */
- void initialize();
-
- /**
- * Generates inline areas.
- * This is used to check if the layout manager generates inline
- * areas.
- *
- * @return true if the layout manager generates inline areas
- */
- boolean generatesInlineAreas();
-
- /**
- * Return true if the next area which would be generated by this
- * LayoutManager could start a new line (or flow for block-level FO).
- *
- * @param lc the layout context
- * @return true if can break before
- */
- boolean canBreakBefore(LayoutContext lc);
-
- /**
- * Generate and return the next break possibility.
- *
- * @param context The layout context contains information about pending
- * space specifiers from ancestor areas or previous areas, reference
- * area inline-progression-dimension and various other layout-related
- * information.
- * @return the next break position
- */
- BreakPoss getNextBreakPoss(LayoutContext context);
-
- /**
- * Reset to the position.
- *
- * @param position
- */
- void resetPosition(Position position);
-
- /**
- * Get the word chars between two positions and
- * append to the string buffer. The positions could
- * span multiple layout managers.
- *
- * @param sbChars the string buffer to append the word chars
- * @param bp1 the start position
- * @param bp2 the end position
- */
- void getWordChars(StringBuffer sbChars, Position bp1,
- Position bp2);
-
- /**
- * Return a value indicating whether this LayoutManager has laid out
- * all its content (or generated BreakPossibilities for all content.)
- *
- * @return true if this layout manager is finished
- */
- boolean isFinished();
-
- /**
- * Set a flag indicating whether the LayoutManager has laid out all
- * its content. This is generally called by the LM itself, but can
- * be called by a parentLM when backtracking.
- *
- * @param isFinished the value to set the finished flag to
- */
- void setFinished(boolean isFinished);
-
- /**
- * Get the parent area for an area.
- * This should get the parent depending on the class of the
- * area passed in.
- *
- * @param childArea the child area to get the parent for
- * @return the parent Area
- */
- Area getParentArea(Area childArea);
-
- /**
- * Add the area as a child of the current area.
- * This is called by child layout managers to add their
- * areas as children of the current area.
- *
- * @param childArea the child area to add
- */
- void addChild(Area childArea);
-
- /**
- * Tell the layout manager to add all the child areas implied
- * by Position objects which will be returned by the
- * Iterator.
- *
- * @param posIter the position iterator
- * @param context the context
- */
- void addAreas(PositionIterator posIter, LayoutContext context);
-
- /**
- * Get the string of the current page number.
- *
- * @return the string for the current page number
- */
- String getCurrentPageNumber();
-
- /**
- * Resolve the id reference.
- * This is called by an area looking for an id reference.
- * If the id reference is not found then it should add a resolvable object.
- *
- * @param ref the id reference
- * @return the page containing the id reference or null if not found
- */
- PageViewport resolveRefID(String ref);
-
- /**
- * Add an id to the page.
- * (todo) add the location of the area on the page
- *
- * @param id the id reference to add.
- */
- void addIDToPage(String id);
-
- /**
- * Add an unresolved area.
- * The is used to add a resolvable object to the page for a given id.
- *
- * @param id the id reference this object needs for resolving
- * @param res the resolvable object
- */
- void addUnresolvedArea(String id, Resolvable res);
-
- /**
- * Add the marker.
- * A number of formatting objects may contain markers. This
- * method is used to add those markers to the page.
- *
- * @param name the marker class name
- * @param start true if the formatting object is starting false is finishing
- * @param isfirst a flag for is first
- */
- void addMarkerMap(Map marks, boolean start, boolean isfirst);
-
- /**
- * Retrieve a marker.
- * This method is used when retrieve a marker.
- *
- * @param name the class name of the marker
- * @param pos the retrieve position
- * @param boundary the boundary for retrieving the marker
- * @return the layout manaager of the retrieved marker if any
- */
- Marker retrieveMarker(String name, int pos, int boundary);
-
- /**
- * Load next child LMs, up to child LM index pos
- * @param pos index up to which child LMs are requested
- * @return if requested index does exist
- */
- boolean preLoadNext(int pos);
-
- /**
- * @return the list of child LMs
- */
- List getChildLMs();
-
- /**
- * Add the LM in the argument to the list of child LMs;
- * set this LM as the parent;
- * initialize the LM.
- * @param lm the LM to be added
- */
- void addChildLM(LayoutManager lm);
-
- /**
- * Add the LMs in the argument to the list of child LMs;
- * @param newLMs the list of LMs to be added
- */
- void addChildLMs(List newLMs);
-
- LinkedList getNextKnuthElements(LayoutContext context, int alignment);
-
- KnuthElement addALetterSpaceTo(KnuthElement element);
-
- void getWordChars(StringBuffer sbChars, Position pos);
-
- void hyphenate(Position pos, HyphContext hc);
-
- boolean applyChanges(List oldList);
-
- LinkedList getChangedKnuthElements(List oldList, int flaggedPenalty,
- int alignment);
-
- int getWordSpaceIPD();
- }
|