org.apache.fop.fo.flow
Class Table

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.FObj
          org.apache.fop.fo.flow.TableFObj
              org.apache.fop.fo.flow.Table

All Implemented Interfaces:

java.lang.Cloneable, Constants

public class Table

extends TableFObj

Class modelling the fo:table object.

Nested Class Summary

Nested classes inherited from class org.apache.fop.fo.flow.TableFObj

TableFObj.ColumnNumberPropertyMaker, TableFObj.PendingSpan

Field Summary

protected java.util.List

columns collection of columns in this table

Fields inherited from class org.apache.fop.fo.FObj

childNodes

Fields inherited from class org.apache.fop.fo.FONode

FO_URI, locator, log, parent

Fields inherited from interface org.apache.fop.fo.Constants

COMPOUND_COUNT, COMPOUND_MASK, COMPOUND_SHIFT, CP_BLOCK_PROGRESSION_DIRECTION, CP_CONDITIONALITY, CP_INLINE_PROGRESSION_DIRECTION, CP_LENGTH, CP_MAXIMUM, CP_MINIMUM, CP_OPTIMUM, CP_PRECEDENCE, CP_WITHIN_COLUMN, CP_WITHIN_LINE, CP_WITHIN_PAGE, EN_100, EN_200, EN_300, EN_400, EN_500, EN_600, EN_700, EN_800, EN_900, EN_ABSOLUTE, EN_ABSOLUTE_COLORMETRIC, EN_AFTER, EN_AFTER_EDGE, EN_ALL, EN_ALPHABETIC, EN_ALWAYS, EN_ANY, EN_AUTO, EN_AUTO_EVEN, EN_AUTO_ODD, EN_AVOID, EN_BACKSLANT, EN_BASELINE, EN_BEFORE, EN_BEFORE_EDGE, EN_BIDI_OVERRIDE, EN_BLANK, EN_BLINK, EN_BLOCK, EN_BOLDER, EN_BOTH, EN_BOTTOM, EN_BOUNDED_IN_ONE_DIMENSION, EN_CAPITALIZE, EN_CAPTION, EN_CENTER, EN_CENTRAL, EN_CHARACTER_BY_CHARACTER, EN_COLLAPSE, EN_COLLAPSE_WITH_PRECEDENCE, EN_COLUMN, EN_CONDENSED, EN_CONSIDER_SHIFTS, EN_DASHED, EN_DISCARD, EN_DISREGARD_SHIFTS, EN_DOCUMENT, EN_DOTS, EN_DOTTED, EN_DOUBLE, EN_EMBED, EN_END, EN_END_ON_EVEN, EN_END_ON_ODD, EN_ERROR_IF_OVERFLOW, EN_EVEN, EN_EVEN_PAGE, EN_EXPANDED, EN_EXTRA_CONDENSED, EN_EXTRA_EXPANDED, EN_FALSE, EN_FIC, EN_FIRST, EN_FIXED, EN_FONT_HEIGHT, EN_FORCE, EN_FSWP, EN_GROOVE, EN_HANGING, EN_HIDDEN, EN_HIDE, EN_ICON, EN_IDEOGRAPHIC, EN_IGNORE, EN_IGNORE_IF_AFTER_LINEFEED, EN_IGNORE_IF_BEFORE_LINEFEED, EN_IGNORE_IF_SURROUNDING_LINEFEED, EN_INDEFINITE, EN_INDENT, EN_INHERIT, EN_INSET, EN_INSIDE, EN_INTEGER_PIXELS, EN_ITALIC, EN_JUSTIFY, EN_LARGER, EN_LAST, EN_LEFT, EN_LEWP, EN_LIGHTER, EN_LINE, EN_LINE_HEIGHT, EN_LINE_THROUGH, EN_LOWERCASE, EN_LR_TB, EN_LSWP, EN_LTR, EN_MATHEMATICAL, EN_MAX_HEIGHT, EN_MENU, EN_MESSAGE_BOX, EN_MIDDLE, EN_NARROWER, EN_NO_BLINK, EN_NO_CHANGE, EN_NO_FORCE, EN_NO_LIMIT, EN_NO_LINE_THROUGH, EN_NO_OVERLINE, EN_NO_UNDERLINE, EN_NO_WRAP, EN_NON_UNIFORM, EN_NONE, EN_NOREPEAT, EN_NORMAL, EN_NOT_BLANK, EN_OBLIQUE, EN_ODD, EN_ODD_PAGE, EN_OUTSET, EN_OUTSIDE, EN_OVERLINE, EN_PAGE, EN_PAGE_SEQUENCE, EN_PAGINATE, EN_PERCEPTUAL, EN_PRE, EN_PRESERVE, EN_REFERENCE_AREA, EN_RELATIVE, EN_RELATIVE_COLOMETRIC, EN_REPEAT, EN_REPEATX, EN_REPEATY, EN_RESAMPLE_ANY_METHOD, EN_RESET_SIZE, EN_REST, EN_RETAIN, EN_RIDGE, EN_RIGHT, EN_RL_TB, EN_RTL, EN_RULE, EN_SATURATION, EN_SCALE_TO_FIT, EN_SCROLL, EN_SEMI_CONDENSED, EN_SEMI_EXPANDED, EN_SEPARATE, EN_SHOW, EN_SMALL_CAPS, EN_SMALL_CAPTION, EN_SMALLER, EN_SOLID, EN_SPACE, EN_START, EN_STATIC, EN_STATUS_BAR, EN_SUB, EN_SUPER, EN_SUPPRESS, EN_TB_RL, EN_TEXT_AFTER_EDGE, EN_TEXT_BEFORE_EDGE, EN_TEXT_BOTTOM, EN_TEXT_TOP, EN_TOP, EN_TRADITIONAL, EN_TREAT_AS_SPACE, EN_TREAT_AS_ZERO_WIDTH_SPACE, EN_TRUE, EN_ULTRA_CONDENSED, EN_ULTRA_EXPANDED, EN_UNBOUNDED, EN_UNDERLINE, EN_UNIFORM, EN_UPPERCASE, EN_USE_FONT_METRICS, EN_USE_SCRIPT, EN_USECONTENT, EN_VISIBLE, EN_WIDER, EN_WRAP, EN_X_DISTRIBUTE, EN_X_FILL, ENUM_COUNT, FO_BASIC_LINK, FO_BIDI_OVERRIDE, FO_BLOCK, FO_BLOCK_CONTAINER, FO_BOOKMARK, FO_BOOKMARK_TITLE, FO_BOOKMARK_TREE, FO_CHARACTER, FO_COLOR_PROFILE, FO_CONDITIONAL_PAGE_MASTER_REFERENCE, FO_DECLARATIONS, FO_EXTERNAL_GRAPHIC, FO_FLOAT, FO_FLOW, FO_FOOTNOTE, FO_FOOTNOTE_BODY, FO_INITIAL_PROPERTY_SET, FO_INLINE, FO_INLINE_CONTAINER, FO_INSTREAM_FOREIGN_OBJECT, FO_LAYOUT_MASTER_SET, FO_LEADER, FO_LIST_BLOCK, FO_LIST_ITEM, FO_LIST_ITEM_BODY, FO_LIST_ITEM_LABEL, FO_MARKER, FO_MULTI_CASE, FO_MULTI_PROPERTIES, FO_MULTI_PROPERTY_SET, FO_MULTI_SWITCH, FO_MULTI_TOGGLE, FO_PAGE_NUMBER, FO_PAGE_NUMBER_CITATION, FO_PAGE_NUMBER_CITATION_LAST, FO_PAGE_SEQUENCE, FO_PAGE_SEQUENCE_MASTER, FO_PAGE_SEQUENCE_WRAPPER, FO_REGION_AFTER, FO_REGION_BEFORE, FO_REGION_BODY, FO_REGION_END, FO_REGION_START, FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES, FO_REPEATABLE_PAGE_MASTER_REFERENCE, FO_RETRIEVE_MARKER, FO_ROOT, FO_SIMPLE_PAGE_MASTER, FO_SINGLE_PAGE_MASTER_REFERENCE, FO_STATIC_CONTENT, FO_TABLE, FO_TABLE_AND_CAPTION, FO_TABLE_BODY, FO_TABLE_CAPTION, FO_TABLE_CELL, FO_TABLE_COLUMN, FO_TABLE_FOOTER, FO_TABLE_HEADER, FO_TABLE_ROW, FO_TITLE, FO_UNKNOWN_NODE, FO_WRAPPER, FRM_OBJ_COUNT, NOT_SET, PR_ABSOLUTE_POSITION, PR_ACTIVE_STATE, PR_ALIGNMENT_ADJUST, PR_ALIGNMENT_BASELINE, PR_AUTO_RESTORE, PR_AZIMUTH, PR_BACKGROUND, PR_BACKGROUND_ATTACHMENT, PR_BACKGROUND_COLOR, PR_BACKGROUND_IMAGE, PR_BACKGROUND_POSITION, PR_BACKGROUND_POSITION_HORIZONTAL, PR_BACKGROUND_POSITION_VERTICAL, PR_BACKGROUND_REPEAT, PR_BASELINE_SHIFT, PR_BLANK_OR_NOT_BLANK, PR_BLOCK_PROGRESSION_DIMENSION, PR_BORDER, PR_BORDER_AFTER_COLOR, PR_BORDER_AFTER_PRECEDENCE, PR_BORDER_AFTER_STYLE, PR_BORDER_AFTER_WIDTH, PR_BORDER_BEFORE_COLOR, PR_BORDER_BEFORE_PRECEDENCE, PR_BORDER_BEFORE_STYLE, PR_BORDER_BEFORE_WIDTH, PR_BORDER_BOTTOM, PR_BORDER_BOTTOM_COLOR, PR_BORDER_BOTTOM_STYLE, PR_BORDER_BOTTOM_WIDTH, PR_BORDER_COLLAPSE, PR_BORDER_COLOR, PR_BORDER_END_COLOR, PR_BORDER_END_PRECEDENCE, PR_BORDER_END_STYLE, PR_BORDER_END_WIDTH, PR_BORDER_LEFT, PR_BORDER_LEFT_COLOR, PR_BORDER_LEFT_STYLE, PR_BORDER_LEFT_WIDTH, PR_BORDER_RIGHT, PR_BORDER_RIGHT_COLOR, PR_BORDER_RIGHT_STYLE, PR_BORDER_RIGHT_WIDTH, PR_BORDER_SEPARATION, PR_BORDER_SPACING, PR_BORDER_START_COLOR, PR_BORDER_START_PRECEDENCE, PR_BORDER_START_STYLE, PR_BORDER_START_WIDTH, PR_BORDER_STYLE, PR_BORDER_TOP, PR_BORDER_TOP_COLOR, PR_BORDER_TOP_STYLE, PR_BORDER_TOP_WIDTH, PR_BORDER_WIDTH, PR_BOTTOM, PR_BREAK_AFTER, PR_BREAK_BEFORE, PR_CAPTION_SIDE, PR_CASE_NAME, PR_CASE_TITLE, PR_CHARACTER, PR_CLEAR, PR_CLIP, PR_COLOR, PR_COLOR_PROFILE_NAME, PR_COLUMN_COUNT, PR_COLUMN_GAP, PR_COLUMN_NUMBER, PR_COLUMN_WIDTH, PR_CONTENT_HEIGHT, PR_CONTENT_TYPE, PR_CONTENT_WIDTH, PR_COUNTRY, PR_CUE, PR_CUE_AFTER, PR_CUE_BEFORE, PR_DESTINATION_PLACEMENT_OFFSET, PR_DIRECTION, PR_DISPLAY_ALIGN, PR_DOMINANT_BASELINE, PR_ELEVATION, PR_EMPTY_CELLS, PR_END_INDENT, PR_ENDS_ROW, PR_EXTENT, PR_EXTERNAL_DESTINATION, PR_FLOAT, PR_FLOW_NAME, PR_FONT, PR_FONT_FAMILY, PR_FONT_SELECTION_STRATEGY, PR_FONT_SIZE, PR_FONT_SIZE_ADJUST, PR_FONT_STRETCH, PR_FONT_STYLE, PR_FONT_VARIANT, PR_FONT_WEIGHT, PR_FORCE_PAGE_COUNT, PR_FORMAT, PR_GLYPH_ORIENTATION_HORIZONTAL, PR_GLYPH_ORIENTATION_VERTICAL, PR_GROUPING_SEPARATOR, PR_GROUPING_SIZE, PR_HEIGHT, PR_HYPHENATE, PR_HYPHENATION_CHARACTER, PR_HYPHENATION_KEEP, PR_HYPHENATION_LADDER_COUNT, PR_HYPHENATION_PUSH_CHARACTER_COUNT, PR_HYPHENATION_REMAIN_CHARACTER_COUNT, PR_ID, PR_INDEX_CLASS, PR_INDEX_KEY, PR_INDICATE_DESTINATION, PR_INITIAL_PAGE_NUMBER, PR_INLINE_PROGRESSION_DIMENSION, PR_INTERNAL_DESTINATION, PR_INTRUSION_DISPLACE, PR_KEEP_TOGETHER, PR_KEEP_WITH_NEXT, PR_KEEP_WITH_PREVIOUS, PR_LANGUAGE, PR_LAST_LINE_END_INDENT, PR_LEADER_ALIGNMENT, PR_LEADER_LENGTH, PR_LEADER_PATTERN, PR_LEADER_PATTERN_WIDTH, PR_LEFT, PR_LETTER_SPACING, PR_LETTER_VALUE, PR_LINE_HEIGHT, PR_LINE_HEIGHT_SHIFT_ADJUSTMENT, PR_LINE_STACKING_STRATEGY, PR_LINEFEED_TREATMENT, PR_MARGIN, PR_MARGIN_BOTTOM, PR_MARGIN_LEFT, PR_MARGIN_RIGHT, PR_MARGIN_TOP, PR_MARKER_CLASS_NAME, PR_MASTER_NAME, PR_MASTER_REFERENCE, PR_MAX_HEIGHT, PR_MAX_WIDTH, PR_MAXIMUM_REPEATS, PR_MEDIA_USAGE, PR_MIN_HEIGHT, PR_MIN_WIDTH, PR_NUMBER_COLUMNS_REPEATED, PR_NUMBER_COLUMNS_SPANNED, PR_NUMBER_ROWS_SPANNED, PR_ODD_OR_EVEN, PR_ORPHANS, PR_OVERFLOW, PR_PADDING, PR_PADDING_AFTER, PR_PADDING_BEFORE, PR_PADDING_BOTTOM, PR_PADDING_END, PR_PADDING_LEFT, PR_PADDING_RIGHT, PR_PADDING_START, PR_PADDING_TOP, PR_PAGE_BREAK_AFTER, PR_PAGE_BREAK_BEFORE, PR_PAGE_BREAK_INSIDE, PR_PAGE_HEIGHT, PR_PAGE_POSITION, PR_PAGE_WIDTH, PR_PAUSE, PR_PAUSE_AFTER, PR_PAUSE_BEFORE, PR_PITCH, PR_PITCH_RANGE, PR_PLAY_DURING, PR_POSITION, PR_PRECEDENCE, PR_PROVISIONAL_DISTANCE_BETWEEN_STARTS, PR_PROVISIONAL_LABEL_SEPARATION, PR_REF_ID, PR_REFERENCE_ORIENTATION, PR_REGION_NAME, PR_RELATIVE_ALIGN, PR_RELATIVE_POSITION, PR_RENDERING_INTENT, PR_RETRIEVE_BOUNDARY, PR_RETRIEVE_CLASS_NAME, PR_RETRIEVE_POSITION, PR_RICHNESS, PR_RIGHT, PR_ROLE, PR_RULE_STYLE, PR_RULE_THICKNESS, PR_SCALING, PR_SCALING_METHOD, PR_SCORE_SPACES, PR_SCRIPT, PR_SHOW_DESTINATION, PR_SIZE, PR_SOURCE_DOCUMENT, PR_SPACE_AFTER, PR_SPACE_BEFORE, PR_SPACE_END, PR_SPACE_START, PR_SPAN, PR_SPEAK, PR_SPEAK_HEADER, PR_SPEAK_NUMERAL, PR_SPEAK_PUNCTUATION, PR_SPEECH_RATE, PR_SRC, PR_START_INDENT, PR_STARTING_STATE, PR_STARTS_ROW, PR_STRESS, PR_SUPPRESS_AT_LINE_BREAK, PR_SWITCH_TO, PR_TABLE_LAYOUT, PR_TABLE_OMIT_FOOTER_AT_BREAK, PR_TABLE_OMIT_HEADER_AT_BREAK, PR_TARGET_PRESENTATION_CONTEXT, PR_TARGET_PROCESSING_CONTEXT, PR_TARGET_STYLESHEET, PR_TEXT_ALIGN, PR_TEXT_ALIGN_LAST, PR_TEXT_ALTITUDE, PR_TEXT_DECORATION, PR_TEXT_DEPTH, PR_TEXT_INDENT, PR_TEXT_SHADOW, PR_TEXT_TRANSFORM, PR_TOP, PR_TREAT_AS_WORD_SPACE, PR_UNICODE_BIDI, PR_VERTICAL_ALIGN, PR_VISIBILITY, PR_VOICE_FAMILY, PR_VOLUME, PR_WHITE_SPACE, PR_WHITE_SPACE_COLLAPSE, PR_WHITE_SPACE_TREATMENT, PR_WIDOWS, PR_WIDTH, PR_WORD_SPACING, PR_WRAP_OPTION, PR_WRITING_MODE, PR_X_BLOCK_PROGRESSION_UNIT, PR_X_ORPHAN_CONTENT_LIMIT, PR_X_WIDOW_CONTENT_LIMIT, PR_XML_LANG, PR_Z_INDEX, PROPERTY_COUNT, PROPERTY_MASK

Constructor Summary

Table(FONode parent)

Method Summary

protected void	addChildNode(FONode child) Adds a node as a child of this node.
protected void	addDefaultColumn(Length colWidth, int colNr) Adds a default column to the columns list (called from TableBody.addChildNode() when the table has no explicit columns, and if processing the first row)
void	bind(PropertyList pList) Bind property values from the property list to the FO node.
FONode	clone(FONode parent, boolean removeChildren) Perform a shallow cloning operation, set its parent, and optionally clean the list of child nodes
protected void	endOfNode() Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached.
protected void	flagColumnIndices(int start, int end) Flags column indices from start to end, and updates the current column index.
LengthRangeProperty	getBlockProgressionDimension()
TableBody	getBody(int index)
int	getBorderCollapse()
LengthPairProperty	getBorderSeparation()
int	getBreakAfter()
int	getBreakBefore()
java.util.List	getColumns()
CommonBorderPaddingBackground	getCommonBorderPaddingBackground()
CommonMarginBlock	getCommonMarginBlock()
int	getCurrentColumnIndex() Returns the current column index of the Table
java.lang.String	getId()
LengthRangeProperty	getInlineProgressionDimension()
KeepProperty	getKeepTogether()
KeepProperty	getKeepWithNext()
KeepProperty	getKeepWithPrevious()
java.lang.String	getLocalName() Returns the local name (i.e. without namespace prefix) of the node
int	getNameId() Returns the Constants class integer value of this node
Length	getOrphanContentLimit()
TableBody	getTableFooter()
TableBody	getTableHeader()
Length	getWidowContentLimit()
boolean	isAutoLayout()
boolean	isColumnNumberUsed(int colNr) Checks if a certain column-number is already occupied
boolean	isSeparateBorderModel()
boolean	mustKeepTogether() Convenience method to check if a keep-together constraint is specified.
boolean	omitFooterAtBreak()
boolean	omitHeaderAtBreak()
void	setCurrentColumnIndex(int newIndex) Sets the current column index of the given Table (used by ColumnNumberPropertyMaker.make() in case the column-number was explicitly specified)
protected void	startOfNode() Called after processNode() is called.
protected void	validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) Checks to make sure, during SAX processing of input document, that the incoming node is valid for the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor

Methods inherited from class org.apache.fop.fo.flow.TableFObj

getBorderPrecedence, getTable

Methods inherited from class org.apache.fop.fo.FObj

addChildTo, addExtensionAttachment, addForeignAttribute, addMarker, checkId, createPropertyList, findAncestor, findNearestAncestorFObj, gatherContextInfo, generatesReferenceAreas, getChildNodeAt, getChildNodes, getChildNodes, getExtensionAttachments, getForeignAttributes, getIsOutOfLineFODescendant, getMarkers, getNamespaceURI, getNormalNamespacePrefix, getPropertyMakerFor, hasMarkers, isBlockItem, isBlockOrInlineItem, isInlineItem, isNeutralItem, notifyChildRemoval, processNode, removeChild

Methods inherited from class org.apache.fop.fo.FONode

addCharacters, attributeError, attributeWarning, canHaveMarkers, charIterator, clone, decorateWithContextInfo, errorText, getContentHandlerFactory, getContextInfo, getExtensionAttachment, getFOEventHandler, getLocator, getLocatorString, getLogger, getName, getName, getNodeString, getParent, getRoot, getUserAgent, inMarker, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, setLocator, tooManyNodesError, tooManyNodesError, warningText

Methods inherited from class java.lang.Object

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

Field Detail

columns

protected java.util.List columns

collection of columns in this table

Constructor Detail

Table

public Table(FONode parent)

Parameters:

parent - FONode that is the parent of this object

Method Detail

bind

public void bind(PropertyList pList)
          throws FOPException

Description copied from class: FObj

Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it.

Overrides:

bind in class TableFObj

Throws:

FOPException

See Also:

FObj.bind(PropertyList)

startOfNode

protected void startOfNode()
                    throws FOPException

Description copied from class: FONode

Called after processNode() is called. Subclasses can do additional processing.

Overrides:

startOfNode in class FONode

Throws:

FOPException - if there's a problem during processing

See Also:

FONode.startOfNode()

validateChildNode

protected void validateChildNode(org.xml.sax.Locator loc,
                                 java.lang.String nsURI,
                                 java.lang.String localName)
                          throws ValidationException

Description copied from class: FONode

Checks to make sure, during SAX processing of input document, that the incoming node is valid for the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor

Overrides:

validateChildNode in class FONode

Parameters:

loc - location in the FO source file

nsURI - namespace of incoming node

localName - (e.g. "table" for "fo:table")

Throws:

ValidationException - if incoming node not valid for parent

See Also:

XSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+)

endOfNode

protected void endOfNode()
                  throws FOPException

Description copied from class: FONode

Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached.

Overrides:

endOfNode in class FONode

Throws:

FOPException - if there's a problem during processing

See Also:

FONode.endOfNode()

addChildNode

protected void addChildNode(FONode child)
                     throws FOPException

Description copied from class: FONode

Adds a node as a child of this node. The default implementation of this method just ignores any child node being added.

Overrides:

addChildNode in class TableFObj

Throws:

FOPException

See Also:

FONode.addChildNode(FONode)

addDefaultColumn

protected void addDefaultColumn(Length colWidth,
                                int colNr)
                         throws FOPException

Adds a default column to the columns list (called from TableBody.addChildNode() when the table has no explicit columns, and if processing the first row)

Parameters:

colWidth - the column's width (null if the default should be used)

colNr - the column-number from the cell

Throws:

FOPException - if there was an error creating the property list

isAutoLayout

public boolean isAutoLayout()

Returns:

true of table-layout="auto"

getColumns

public java.util.List getColumns()

Returns:

the list of table-column elements.

getBody

public TableBody getBody(int index)

Parameters:

index - index of the table-body element.

Returns:

the requested table-body element

getTableHeader

public TableBody getTableHeader()

Returns:

the body for the table-header.

getTableFooter

public TableBody getTableFooter()

Returns:

the body for the table-footer.

omitHeaderAtBreak

public boolean omitHeaderAtBreak()

Returns:

true if the table-header should be omitted at breaks

omitFooterAtBreak

public boolean omitFooterAtBreak()

Returns:

true if the table-footer should be omitted at breaks

getInlineProgressionDimension

public LengthRangeProperty getInlineProgressionDimension()

Returns:

the "inline-progression-dimension" property.

getBlockProgressionDimension

public LengthRangeProperty getBlockProgressionDimension()

Returns:

the "block-progression-dimension" property.

getCommonMarginBlock

public CommonMarginBlock getCommonMarginBlock()

Returns:

the Common Margin Properties-Block.

getCommonBorderPaddingBackground

public CommonBorderPaddingBackground getCommonBorderPaddingBackground()

Specified by:

getCommonBorderPaddingBackground in class TableFObj

Returns:

the Common Border, Padding, and Background Properties.

getBreakAfter

public int getBreakAfter()

Returns:

the "break-after" property.

getBreakBefore

public int getBreakBefore()

Returns:

the "break-before" property.

getKeepWithNext

public KeepProperty getKeepWithNext()

Returns:

the "keep-with-next" property.

getKeepWithPrevious

public KeepProperty getKeepWithPrevious()

Returns:

the "keep-with-previous" property.

getKeepTogether

public KeepProperty getKeepTogether()

Returns:

the "keep-together" property.

mustKeepTogether

public boolean mustKeepTogether()

Convenience method to check if a keep-together constraint is specified.

Returns:

true if keep-together is active.

getBorderCollapse

public int getBorderCollapse()

Returns:

the "border-collapse" property.

isSeparateBorderModel

public boolean isSeparateBorderModel()

Returns:

true if the separate border model is active

getBorderSeparation

public LengthPairProperty getBorderSeparation()

Returns:

the "border-separation" property.

getWidowContentLimit

public Length getWidowContentLimit()

Returns:

the "fox:widow-content-limit" extension property

getOrphanContentLimit

public Length getOrphanContentLimit()

Returns:

the "fox:orphan-content-limit" extension property

getId

public java.lang.String getId()

Returns:

the "id" property.

getLocalName

public java.lang.String getLocalName()

Description copied from class: FONode

Returns the local name (i.e. without namespace prefix) of the node

Specified by:

getLocalName in class FONode

Returns:

the local name of this node

See Also:

FONode.getLocalName()

getNameId

public int getNameId()

Description copied from class: FONode

Returns the Constants class integer value of this node

Overrides:

getNameId in class FONode

Returns:

the integer enumeration of this FO (e.g., FO_ROOT) if a formatting object, FO_UNKNOWN_NODE otherwise

See Also:

FONode.getNameId()

getCurrentColumnIndex

public int getCurrentColumnIndex()

Returns the current column index of the Table

Overrides:

getCurrentColumnIndex in class TableFObj

Returns:

the next column number to use

isColumnNumberUsed

public boolean isColumnNumberUsed(int colNr)

Checks if a certain column-number is already occupied

Overrides:

isColumnNumberUsed in class TableFObj

Parameters:

colNr - the column-number to check

Returns:

true if column-number is already in use

setCurrentColumnIndex

public void setCurrentColumnIndex(int newIndex)

Sets the current column index of the given Table (used by ColumnNumberPropertyMaker.make() in case the column-number was explicitly specified)

Overrides:

setCurrentColumnIndex in class TableFObj

Parameters:

newIndex - the new value for column index

flagColumnIndices

protected void flagColumnIndices(int start,
                                 int end)

Description copied from class: TableFObj

Flags column indices from start to end, and updates the current column index. Overridden for Table, TableBody, TableRow

Overrides:

flagColumnIndices in class TableFObj

Parameters:

start - start index

end - end index

See Also:

TableFObj.flagColumnIndices(int, int)

clone

public FONode clone(FONode parent,
                    boolean removeChildren)
             throws FOPException

Description copied from class: FONode

Perform a shallow cloning operation, set its parent, and optionally clean the list of child nodes

Overrides:

clone in class FObj

Throws:

FOPException

See Also:

FONode.clone(FONode, boolean)