org.apache.fop.layout
Class LineArea

org.apache.fop.layout.Box
  |
  +--org.apache.fop.layout.Area
        |
        +--org.apache.fop.layout.LineArea

public class LineArea
extends Area


Fields inherited from class org.apache.fop.layout.Area
borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderStyleBottom, borderStyleLeft, borderStyleRight, borderStyleTop, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop

Constructor Summary
LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
           

Method Summary
 intaddCharacter(char data, LinkSet ls, boolean ul)
          adds a single character to the line area tree
 voidaddLeader(int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleStyle, int ruleThickness, int leaderPatternWidth, int leaderAlignment)
          adds a Leader; actually the method receives the leader properties and creates a leader area or an inline area which is appended to the children of the containing line area.
 intaddPageNumberCitation(String refid, LinkSet ls)
           
 voidaddPending()
          adds pending inline areas to the line area normally done, when the line area is filled and added as child to the parent block area
 intaddText(char[] odata, int start, int end, LinkSet ls, boolean ul)
          adds text to line area
 voidalign(int type)
          aligns line area
 voidchangeColor(float red, float green, float blue)
           
 voidchangeFont(FontState fontState)
           
 voidchangeHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)
          sets hyphenation related traits: language, country, hyphenate, hyphenation-character and minimum number of character to remain one the previous line and to be on the next line.
 voidchangeWhiteSpaceCollapse(int whiteSpaceCollapse)
           
 voidchangeWrapOption(int wrapOption)
           
 intgetEndIndent()
           
 intgetHeight()
           
 VectorgetPendingAreas()
           
 intgetPendingWidth()
           
 intgetPlacementOffset()
           
 intgetStartIndent()
           
 booleanisEmpty()
           
 voidrender(Renderer renderer)
           
 voidsetPendingAreas(Vector areas)
           
 voidsetPendingWidth(int width)
           

Methods inherited from class org.apache.fop.layout.Area
addChild, addChildAtStart, addDisplaySpace, end, getAbsoluteHeight, getAllocationWidth, getBackgroundColor, getChildren, getContentHeight, getContentWidth, getFontInfo, getFontState, getIDReferences, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPage, getParent, getTableCellXOffset, increaseAbsoluteHeight, increaseHeight, remove, removeChild, removeChild, setAbsoluteHeight, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setHeight, setIDReferences, setMaxHeight, setPadding, setPage, setTableCellXOffset, spaceLeft, start

Constructor Detail

LineArea

public LineArea(FontState fontState, int lineHeight, int halfLeading, int allocationWidth, int startIndent, int endIndent, LineArea prevLineArea)
Method Detail

addCharacter

public int addCharacter(char data, LinkSet ls, boolean ul)
adds a single character to the line area tree

addLeader

public void addLeader(int leaderPattern, int leaderLengthMinimum, int leaderLengthOptimum, int leaderLengthMaximum, int ruleStyle, int ruleThickness, int leaderPatternWidth, int leaderAlignment)
adds a Leader; actually the method receives the leader properties and creates a leader area or an inline area which is appended to the children of the containing line area.
leader pattern use-content is not implemented.

addPageNumberCitation

public int addPageNumberCitation(String refid, LinkSet ls)

addPending

public void addPending()
adds pending inline areas to the line area normally done, when the line area is filled and added as child to the parent block area

addText

public int addText(char[] odata, int start, int end, LinkSet ls, boolean ul)
adds text to line area
Returns: int character position

align

public void align(int type)
aligns line area

changeColor

public void changeColor(float red, float green, float blue)

changeFont

public void changeFont(FontState fontState)

changeHyphenation

public void changeHyphenation(String language, String country, int hyphenate, char hyphenationChar, int hyphenationPushCharacterCount, int hyphenationRemainCharacterCount)
sets hyphenation related traits: language, country, hyphenate, hyphenation-character and minimum number of character to remain one the previous line and to be on the next line.

changeWhiteSpaceCollapse

public void changeWhiteSpaceCollapse(int whiteSpaceCollapse)

changeWrapOption

public void changeWrapOption(int wrapOption)

getEndIndent

public int getEndIndent()

getHeight

public int getHeight()

getPendingAreas

public Vector getPendingAreas()

getPendingWidth

public int getPendingWidth()

getPlacementOffset

public int getPlacementOffset()

getStartIndent

public int getStartIndent()

isEmpty

public boolean isEmpty()

render

public void render(Renderer renderer)

setPendingAreas

public void setPendingAreas(Vector areas)

setPendingWidth

public void setPendingWidth(int width)

Association Links

to Class org.apache.fop.layout.FontState

to Class java.lang.String

to Class java.lang.String

to Class java.util.Vector