de.vc.jfo.flow

Class InlineContainer

java.lang.Object

de.vc.xml.AbstractNode

de.vc.xml.AbstractNodeWithAttributes

de.vc.jfo.FormattingObject

de.vc.jfo.flow.FlowObject

de.vc.jfo.flow.FlowObjectWithElements

de.vc.jfo.flow.InlineContainer

All Implemented Interfaces:

InlineElement, Node, NodeElement, java.io.Serializable, java.lang.Cloneable

public class InlineContainer
extends FlowObjectWithElements
implements InlineElement

The fo:inline-container flow object is used to generate an inline reference-area, typically containing text blocks with a different writing-mode.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.vc.jfo.FormattingObject

EMPTY_ARRAY

Fields inherited from class de.vc.xml.AbstractNodeWithAttributes

MAP_TYPE_FLYWEIGHT, MAP_TYPE_HASH

Constructor Summary

Constructors

Constructor and Description
InlineContainer()

Method Summary

Modifier and Type	Method and Description
InlineContainer	add(BlockElement element) Adds an formatting object (that is a block-group-member) to this FO.
InlineContainer	add(int idx, BlockElement element) Adds an formatting object (that is a block-group-member) to this FO.
Background	getBackground() Gets the background of this fo.
Border	getBorder() Gets the border of this fo.
Values.DisplayAlignment	getDisplayAlign() Gets the display-alignment.
Padding	getPadding() Gets the padding of this fo.
RelativePosition	getRelativePosition() Gets the relative position of this fo.
Values.WritingMode	getWritingMode() Gets the writing mode of this formatting object.
boolean	hasBorder() Returns true if at least one border attribute is set.
void	setBackground(Background bg) Sets the background of this fo.
void	setBorder(Border border) Sets the border of this fo.
void	setDisplayAlign(Values.DisplayAlignment align) Sets the display-alignment.
void	setPadding(Padding padding) Sets the padding of this fo.
void	setRelativePosition(RelativePosition pos) Sets the relative position of this fo.
void	setWritingMode(Values.WritingMode mode) Sets the writing mode for this formatting object.

Methods inherited from class de.vc.jfo.flow.FlowObjectWithElements

add, add, add, add, addAllImpl, addAllUnsafe, addAllUnsafe, addElement, addElement, addElements, addElements, addUnsafe, addUnsafe, clone, firstElement, getElementCount, getElements, isEmpty, lastElement, remove, remove, removeAll, removeElement, removeElement, removeLast, replaceElement, setElement

Methods inherited from class de.vc.jfo.FormattingObject

cloned, clonedList, createUniqueID, createUniqueID, doGetAttribute, doSetAttribute, elementCount, get, getAbsolutePosition, getAccessibility, getAttributeMap, getDefinedAttributes, getDocument, getFont, getID, getLanguage, getLogger, getMargin, getMeasureValue, getObjectValue, getObjectValue, getObjectValue, getObjectValue, getOrphans, getParentFO, getWidows, hasID, hasPadding, isHyphenation, setAbsolutePosition, setAccessibility, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setFont, setHyphenation, setID, setLanguage, setLanguage, setMargin, setOrphans, setWidows

Methods inherited from class de.vc.xml.AbstractNodeWithAttributes

getDefaultMapType, setDefaultMapType

Methods inherited from class de.vc.xml.AbstractNode

addAttributeChangeListener, clearEqualAttributes, clearInheratedAttribute, clearInheratedAttributes, clearValue, contains, contains, copyAttributes, createID, findFirstNodeWithText, findNode, findNodesWithText, fire, fireSaxEvents, getAttrAsBoolean, getAttrAsInteger, getAttrAsString, getAttrAsString, getAttribute, getAttribute, getAttributeMap, getContentText, getContentText, getDefinedAttributes, getElements, getElements, getElements, getFirstElement, getIndex, getLocalName, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getParent, getParent, getParent, getParentOrThis, getQName, getRoot, hasEqualAttrs, indexOf, liftInheritedAttribute, removeAttributeChangeListener, setAttribute, setAttributes, setAttrIfNotNull, setEnableAttributeChangeEvent, setNamespace, setParent, setQName, setUndefinedAttributes, writeTo, writeTo, writeTo, writeTo

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.vc.xml.Node

addAttributeChangeListener, addElement, addElement, clearInheratedAttribute, clearInheratedAttributes, clearValue, contains, fireSaxEvents, firstElement, getAttrAsString, getAttrAsString, getAttribute, getAttribute, getAttributeMap, getContentText, getDefinedAttributes, getElements, getElements, getLocalName, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getQName, getRoot, indexOf, isEmpty, lastElement, removeAttributeChangeListener, removeElement, removeElement, replaceElement, setAttribute, setAttributes, setElement, setNamespace

Methods inherited from interface de.vc.xml.NodeElement

clone, getParent, setParent, writeTo

Constructor Detail

InlineContainer

public InlineContainer()

Method Detail

add

public InlineContainer add(BlockElement element)

Adds an formatting object (that is a block-group-member) to this FO. at end.

Parameters:

element - FormattingObject.

Returns:

This inline-container for chained calls.

add

public InlineContainer add(int idx,
                           BlockElement element)

Adds an formatting object (that is a block-group-member) to this FO. at the given index.

Parameters:

idx - Index.

element - FormattingObject.

Returns:

This inline-container for chained calls.

getPadding

public Padding getPadding()

Gets the padding of this fo. Is never null.

Overrides:

getPadding in class FormattingObject

Returns:

Padding.

setPadding

public void setPadding(Padding padding)

Sets the padding of this fo.

Overrides:

setPadding in class FormattingObject

Parameters:

padding - Padding.

hasBorder

public boolean hasBorder()

Returns true if at least one border attribute is set.

Overrides:

hasBorder in class FormattingObject

Returns:

True if at least one border attribute is set.

getBorder

public Border getBorder()

Gets the border of this fo. Is never null.

Overrides:

getBorder in class FormattingObject

Returns:

Border.

setBorder

public void setBorder(Border border)

Sets the border of this fo. If border is NULL, an empty border is created.

Overrides:

setBorder in class FormattingObject

Parameters:

border - Border.

getBackground

public Background getBackground()

Gets the background of this fo. Is never null.

Overrides:

getBackground in class FormattingObject

Returns:

Background.

setBackground

public void setBackground(Background bg)

Sets the background of this fo.

Overrides:

setBackground in class FormattingObject

Parameters:

bg - Background.

getRelativePosition

public RelativePosition getRelativePosition()

Gets the relative position of this fo. Is never null.

Overrides:

getRelativePosition in class FormattingObject

Returns:

RelativePosition.

setRelativePosition

public void setRelativePosition(RelativePosition pos)

Sets the relative position of this fo.

Overrides:

setRelativePosition in class FormattingObject

Parameters:

pos - RelativePosition.

setDisplayAlign

public void setDisplayAlign(Values.DisplayAlignment align)

Sets the display-alignment.

Parameters:

align - Alignment.

getDisplayAlign

public Values.DisplayAlignment getDisplayAlign()

Gets the display-alignment. By default DISPLAY_ALIGN_BEFORE is returned.

Returns:

Alignment.

getWritingMode

public Values.WritingMode getWritingMode()

Gets the writing mode of this formatting object. If no writing mode is specified the default writing mode LR-TB is returned.

Returns:

Writing mode.

setWritingMode

public void setWritingMode(Values.WritingMode mode)

Sets the writing mode for this formatting object.

Parameters:

mode - Writing mode.