View Javadoc

1   /*
2    * Copyright 2009 - 2009 JEuclid, http://jeuclid.sf.net
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  /* $Id: TextContentModifier.java,v 923658a2b249 2009/09/11 09:57:31 max $ */
18  
19  package net.sourceforge.jeuclid.elements.support.text;
20  
21  import java.text.AttributedCharacterIterator;
22  
23  import net.sourceforge.jeuclid.LayoutContext;
24  
25  /**
26   * 
27   * @version $Revision: 923658a2b249 $
28   */
29  public interface TextContentModifier {
30  
31      /**
32       * modified the given Characters to match what is required for this element.
33       * 
34       * @param aci
35       *            {@link AttributedCharacterIterator} based on the text
36       *            contents.
37       * @param layoutContext
38       *            current layout context.
39       * @return a new {@link AttributedCharacterIterator} which is to be used
40       *         instead.
41       */
42      AttributedCharacterIterator modifyTextContent(
43              AttributedCharacterIterator aci, LayoutContext layoutContext);
44  
45  }