Docmosis API 4.8.0

com.docmosis.template.analysis
Class TableCellStyle

java.lang.Object
  extended by com.docmosis.template.analysis.TableCellStyle
All Implemented Interfaces:
Serializable

public class TableCellStyle
extends Object
implements Serializable

Style information for a table cell.

See Also:
Serialized Form

Nested Class Summary
static class TableCellStyle.RepeatingRowTopAndBottomBorderStyles
          This class manages the transitions for border styles for repeating rows.
 
Field Summary
static char[] ATTRIBUTE_BACKGROUND_COLOUR_CHARS
           
static String ATTRIBUTE_BORDER_STYLE
           
static String ATTRIBUTE_BORDER_STYLE_BOTTOM
           
static String ATTRIBUTE_BORDER_STYLE_LEFT
           
static String ATTRIBUTE_BORDER_STYLE_RIGHT
           
static String ATTRIBUTE_BORDER_STYLE_TOP
           
 
Constructor Summary
TableCellStyle(List styleXML)
           
TableCellStyle(TableCellStyle copyFrom)
          Create a clone of this TableCellStyle.
 
Method Summary
 boolean borderStylesVary()
          Determine if the border style changes for this cell from row to row.
 boolean dynamicStylingApplies()
          Determine if styling information can vary from row to row for this cell.
 String getBaseStyleName()
           
 String getBgColourEven()
           
 String getBgColourOdd()
           
 TableCellStyle.RepeatingRowTopAndBottomBorderStyles getBorderStyles()
           
 String getOrigBgColour()
           
 String getOrigBottomBorder()
           
 String getOriginalLeftBorder()
           
 String getOriginalRightBorder()
           
 String getOriginalTopBottomBorder()
           
 String getOrigTopBorder()
           
 char[] getPostStyleName()
          Return the section of xml immediately after the style name.
 char[] getPreStyleName()
          Get the pre-style name section of xml.
 char[] getRemainder()
          Return the remaining (static) xml portion of the style.
 void setAlternatingBackgroundColours(String bgColourEven, String bgColourOdd)
          Plug in alternating bg colour attributes.
 void setBorderStyles(String borderStyleFirstTop, String borderStyleLastBottom)
          Set the border styles for the first top and last bottom border.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_BACKGROUND_COLOUR_CHARS

public static final char[] ATTRIBUTE_BACKGROUND_COLOUR_CHARS

ATTRIBUTE_BORDER_STYLE_TOP

public static final String ATTRIBUTE_BORDER_STYLE_TOP
See Also:
Constant Field Values

ATTRIBUTE_BORDER_STYLE_BOTTOM

public static final String ATTRIBUTE_BORDER_STYLE_BOTTOM
See Also:
Constant Field Values

ATTRIBUTE_BORDER_STYLE_LEFT

public static final String ATTRIBUTE_BORDER_STYLE_LEFT
See Also:
Constant Field Values

ATTRIBUTE_BORDER_STYLE_RIGHT

public static final String ATTRIBUTE_BORDER_STYLE_RIGHT
See Also:
Constant Field Values

ATTRIBUTE_BORDER_STYLE

public static final String ATTRIBUTE_BORDER_STYLE
See Also:
Constant Field Values
Constructor Detail

TableCellStyle

public TableCellStyle(List styleXML)

TableCellStyle

public TableCellStyle(TableCellStyle copyFrom)
Create a clone of this TableCellStyle.

Parameters:
copyFrom - the table cell style to clone
Method Detail

setBorderStyles

public void setBorderStyles(String borderStyleFirstTop,
                            String borderStyleLastBottom)
Set the border styles for the first top and last bottom border. This will be expanded into a set of borders that can be applied to the cell when it is being rendered as the first, intermediate, last or only row.

Parameters:
borderStyleFirstTop -
borderStyleLastBottom -

borderStylesVary

public boolean borderStylesVary()
Determine if the border style changes for this cell from row to row. This call is only useful after a call to setBorderStyles() is made.


dynamicStylingApplies

public boolean dynamicStylingApplies()
Determine if styling information can vary from row to row for this cell. This is based on bg colour alternation or varying top and bottom border combinations.

Returns:

setAlternatingBackgroundColours

public void setAlternatingBackgroundColours(String bgColourEven,
                                            String bgColourOdd)
Plug in alternating bg colour attributes. If set, these will be used to alternate the background colour of the cell on a row by row basis.

Parameters:
bgColourEven -
bgColourOdd -

getPreStyleName

public char[] getPreStyleName()
Get the pre-style name section of xml.

Returns:
the string

getPostStyleName

public char[] getPostStyleName()
Return the section of xml immediately after the style name.

Returns:
the string

getRemainder

public char[] getRemainder()
Return the remaining (static) xml portion of the style.

Returns:
the string

getBaseStyleName

public String getBaseStyleName()

getBgColourEven

public String getBgColourEven()

getBgColourOdd

public String getBgColourOdd()

getBorderStyles

public TableCellStyle.RepeatingRowTopAndBottomBorderStyles getBorderStyles()

getOrigBgColour

public String getOrigBgColour()

getOrigTopBorder

public String getOrigTopBorder()

getOrigBottomBorder

public String getOrigBottomBorder()

getOriginalTopBottomBorder

public String getOriginalTopBottomBorder()

getOriginalLeftBorder

public String getOriginalLeftBorder()

getOriginalRightBorder

public String getOriginalRightBorder()

Docmosis API 4.8.0

Copyright © 2014–2024 Docmosis Pty Ltd. All rights reserved.