01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: /* $Id: InlineLevelLayoutManager.java 426576 2006-07-28 15:44:37Z jeremias $ */
19:
20: package org.apache.fop.layoutmgr.inline;
21:
22: import java.util.List;
23:
24: import org.apache.fop.layoutmgr.LayoutManager;
25: import org.apache.fop.layoutmgr.Position;
26:
27: /**
28: * The interface for LayoutManagers which generate inline areas
29: */
30: public interface InlineLevelLayoutManager extends LayoutManager {
31:
32: /**
33: * Tell the LM to modify its data, adding a letter space
34: * to the word fragment represented by the given elements,
35: * and returning the corrected elements
36: *
37: * @param oldList the elements which must be given one more letter space
38: * @return the new elements replacing the old ones
39: */
40: List addALetterSpaceTo(List oldList);
41:
42: /**
43: * Tell the LM to modify its data, removing the word space
44: * represented by the given elements
45: *
46: * @param oldList the elements representing the word space
47: */
48: void removeWordSpace(List oldList);
49:
50: /**
51: * Get the word chars corresponding to the given position
52: *
53: * @param sbChars the StringBuffer used to append word chars
54: * @param pos the Position referring to the needed word chars
55: */
56: void getWordChars(StringBuffer sbChars, Position pos);
57:
58: /**
59: * Tell the LM to hyphenate a word
60: *
61: * @param pos the Position referring to the word
62: * @param hc the HyphContext storing hyphenation information
63: */
64: void hyphenate(Position pos, HyphContext hc);
65:
66: /**
67: * Tell the LM to apply the changes due to hyphenation
68: *
69: * @param oldList the list of the old elements the changes refer to
70: * @return true if the LM had to change its data, false otherwise
71: */
72: boolean applyChanges(List oldList);
73:
74: }
|