AT_CellContext (ASCII Table 0.3.2 API)

Object
- AT_CellContext

All Implemented Interfaces:

CategoryIs, IsTableCellContext, IsObjectContext
```
public class AT_CellContext
extends Object
implements IsTableCellContext
```
Context (all configuration parameters) for an AT_Cell.

Since:

v0.3.0

Version:

v0.3.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields
Modifier and Type	Field and Description
`protected CharacterTranslator`	`charTranslator` A simple character translator.
`protected HtmlElementTranslator`	`htmlElementTranslator` A translator for HTML elements.
`protected int`	`paddingBottom` The padding for the bottom of a text line.
`protected Character`	`paddingBottomChar` The padding character for the bottom of a text line.
`protected int`	`paddingLeft` The padding for left side of a text line.
`protected Character`	`paddingLeftChar` The padding character for left side of a text line.
`protected int`	`paddingRight` The padding for right side of a text line.
`protected Character`	`paddingRightChar` The padding character for right side of a text line.
`protected int`	`paddingTop` The padding for the top of a text line.
`protected Character`	`paddingTopChar` The padding character for the top of a text line.
`protected TargetTranslator`	`targetTranslator` A translator for a particular target.
`protected TextAlignment`	`textAlignment` Text alignment, default is `TextAlignment.JUSTIFIED_LEFT`.

Constructor Summary

Constructors
Constructor and Description

AT_CellContext()

Constructors
Constructor and Description
`AT_CellContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharacterTranslator`	`getCharTranslator()` Returns the character translator
`HtmlElementTranslator`	`getHtmlElementTranslator()` Returns the HTML entity translator.
`int`	`getPaddingBottom()` Returns the bottom padding.
`Character`	`getPaddingBottomChar()` Returns the bottom padding character.
`int`	`getPaddingLeft()` Returns the left padding.
`Character`	`getPaddingLeftChar()` Returns the left padding character.
`int`	`getPaddingRight()` Returns the right padding.
`Character`	`getPaddingRightChar()` Returns the right padding character.
`int`	`getPaddingTop()` Returns the top padding.
`Character`	`getPaddingTopChar()` Returns the top padding character.
`TargetTranslator`	`getTargetTranslator()` Returns the target translator.
`TextAlignment`	`getTextAlignment()` Returns the set text alignment.
`void`	`setCharTranslator(CharacterTranslator charTranslator)` Sets the character translator.
`void`	`setHtmlElementTranslator(HtmlElementTranslator htmlElementTranslator)` Sets the HTML entity translator.
`AT_CellContext`	`setPadding(int padding)` Sets all padding to the same value.
`AT_CellContext`	`setPaddingBottom(int paddingBottom)` Sets the bottom padding.
`AT_CellContext`	`setPaddingBottomChar(Character paddingBottomChar)` Sets the bottom padding character.
`AT_CellContext`	`setPaddingLeft(int paddingLeft)` Sets the left padding.
`AT_CellContext`	`setPaddingLeftChar(Character paddingLeftChar)` Sets the left padding character.
`AT_CellContext`	`setPaddingLeftRight(int padding)` Sets left and right padding.
`AT_CellContext`	`setPaddingLeftRight(int paddingLeft, int paddingRight)` Sets left and right padding (only if both values are not smaller than 0).
`AT_CellContext`	`setPaddingRight(int paddingRight)` Sets the right padding.
`AT_CellContext`	`setPaddingRightChar(Character paddingRightChar)` Sets the right padding character.
`AT_CellContext`	`setPaddingTop(int paddingTop)` Sets the top padding.
`AT_CellContext`	`setPaddingTopBottom(int padding)` Sets top and bottom padding.
`AT_CellContext`	`setPaddingTopBottom(int paddingTop, int paddingBottom)` Sets top and bottom padding (only if both values are not smaller than 0).
`AT_CellContext`	`setPaddingTopChar(Character paddingTopChar)` Sets the top padding character.
`void`	`setTargetTranslator(TargetTranslator targetTranslator)` Sets the target translator.
`AT_CellContext`	`setTextAlignment(TextAlignment textAlignment)` Sets the text alignment.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - charTranslator
```
protected CharacterTranslator charTranslator
```
    A simple character translator.
  - htmlElementTranslator
```
protected HtmlElementTranslator htmlElementTranslator
```
    A translator for HTML elements.
  - paddingBottom
```
protected int paddingBottom
```
    The padding for the bottom of a text line.
  - paddingBottomChar
```
protected Character paddingBottomChar
```
    The padding character for the bottom of a text line.
  - paddingLeft
```
protected int paddingLeft
```
    The padding for left side of a text line.
  - paddingLeftChar
```
protected Character paddingLeftChar
```
    The padding character for left side of a text line.
  - paddingRight
```
protected int paddingRight
```
    The padding for right side of a text line.
  - paddingRightChar
```
protected Character paddingRightChar
```
    The padding character for right side of a text line.
  - paddingTop
```
protected int paddingTop
```
    The padding for the top of a text line.
  - paddingTopChar
```
protected Character paddingTopChar
```
    The padding character for the top of a text line.
  - targetTranslator
```
protected TargetTranslator targetTranslator
```
    A translator for a particular target.
  - textAlignment
```
protected TextAlignment textAlignment
```
    Text alignment, default is TextAlignment.JUSTIFIED_LEFT.
- Constructor Detail
  - AT_CellContext
```
public AT_CellContext()
```
- Method Detail
  - getCharTranslator
```
public CharacterTranslator getCharTranslator()
```
    Returns the character translator
    
    Returns:
    
    character translator
  - getHtmlElementTranslator
```
public HtmlElementTranslator getHtmlElementTranslator()
```
    Returns the HTML entity translator.
    
    Returns:
    
    HTML entity
  - getPaddingBottom
```
public int getPaddingBottom()
```
    Returns the bottom padding.
    
    Returns:
    
    bottom padding, 0 if none set
  - getPaddingBottomChar
```
public Character getPaddingBottomChar()
```
    Returns the bottom padding character.
    
    Returns:
    
    bottom padding character
  - getPaddingLeft
```
public int getPaddingLeft()
```
    Returns the left padding.
    
    Returns:
    
    left padding, 0 if none set
  - getPaddingLeftChar
```
public Character getPaddingLeftChar()
```
    Returns the left padding character.
    
    Returns:
    
    left padding character
  - getPaddingRight
```
public int getPaddingRight()
```
    Returns the right padding.
    
    Returns:
    
    right padding, 0 if none set
  - getPaddingRightChar
```
public Character getPaddingRightChar()
```
    Returns the right padding character.
    
    Returns:
    
    right padding character
  - getPaddingTop
```
public int getPaddingTop()
```
    Returns the top padding.
    
    Returns:
    
    top padding, 0 if none set
  - getPaddingTopChar
```
public Character getPaddingTopChar()
```
    Returns the top padding character.
    
    Returns:
    
    top padding character
  - getTargetTranslator
```
public TargetTranslator getTargetTranslator()
```
    Returns the target translator.
    
    Returns:
    
    target translator, null if not set
  - getTextAlignment
```
public TextAlignment getTextAlignment()
```
    Returns the set text alignment.
    
    Returns:
    
    text alignment
  - setCharTranslator
```
public void setCharTranslator(CharacterTranslator charTranslator)
```
    Sets the character translator. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    charTranslator - translator
  - setHtmlElementTranslator
```
public void setHtmlElementTranslator(HtmlElementTranslator htmlElementTranslator)
```
    Sets the HTML entity translator. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    htmlElementTranslator - translator
  - setPadding
```
public AT_CellContext setPadding(int padding)
```
    Sets all padding to the same value.
    
    Parameters:
    
    padding - new padding for top, bottom, left, and right, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingBottom
```
public AT_CellContext setPaddingBottom(int paddingBottom)
```
    Sets the bottom padding.
    
    Parameters:
    
    paddingBottom - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingBottomChar
```
public AT_CellContext setPaddingBottomChar(Character paddingBottomChar)
```
    Sets the bottom padding character.
    
    Parameters:
    
    paddingBottomChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingLeft
```
public AT_CellContext setPaddingLeft(int paddingLeft)
```
    Sets the left padding.
    
    Parameters:
    
    paddingLeft - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftChar
```
public AT_CellContext setPaddingLeftChar(Character paddingLeftChar)
```
    Sets the left padding character.
    
    Parameters:
    
    paddingLeftChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftRight
```
public AT_CellContext setPaddingLeftRight(int padding)
```
    Sets left and right padding.
    
    Parameters:
    
    padding - new padding for left and right, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingLeftRight
```
public AT_CellContext setPaddingLeftRight(int paddingLeft,
                                          int paddingRight)
```
    Sets left and right padding (only if both values are not smaller than 0).
    
    Parameters:
    
    paddingLeft - new left padding, ignored if smaller than 0
    
    paddingRight - new right padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingRight
```
public AT_CellContext setPaddingRight(int paddingRight)
```
    Sets the right padding.
    
    Parameters:
    
    paddingRight - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingRightChar
```
public AT_CellContext setPaddingRightChar(Character paddingRightChar)
```
    Sets the right padding character.
    
    Parameters:
    
    paddingRightChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setPaddingTop
```
public AT_CellContext setPaddingTop(int paddingTop)
```
    Sets the top padding.
    
    Parameters:
    
    paddingTop - new padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopBottom
```
public AT_CellContext setPaddingTopBottom(int padding)
```
    Sets top and bottom padding.
    
    Parameters:
    
    padding - new padding for top and bottom, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopBottom
```
public AT_CellContext setPaddingTopBottom(int paddingTop,
                                          int paddingBottom)
```
    Sets top and bottom padding (only if both values are not smaller than 0).
    
    Parameters:
    
    paddingTop - new top padding, ignored if smaller than 0
    
    paddingBottom - new bottom padding, ignored if smaller than 0
    
    Returns:
    
    this to allow chaining
  - setPaddingTopChar
```
public AT_CellContext setPaddingTopChar(Character paddingTopChar)
```
    Sets the top padding character.
    
    Parameters:
    
    paddingTopChar - new padding character, ignored if null
    
    Returns:
    
    this to allow chaining
  - setTargetTranslator
```
public void setTargetTranslator(TargetTranslator targetTranslator)
```
    Sets the target translator. It will also remove any other translator set. Nothing will happen if the argument is null.
    
    Parameters:
    
    targetTranslator - translator
  - setTextAlignment
```
public AT_CellContext setTextAlignment(TextAlignment textAlignment)
```
    Sets the text alignment.
    
    Parameters:
    
    textAlignment - new text alignment
    
    Returns:
    
    this to allow chaining
    
    Throws:
    
    NullPointerException - if the argument was null
    
    {@link - NullPointerException} if the argument was null

Class AT_CellContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

charTranslator

htmlElementTranslator

paddingBottom

paddingBottomChar

paddingLeft

paddingLeftChar

paddingRight

paddingRightChar

paddingTop

paddingTopChar

targetTranslator

textAlignment

Constructor Detail

AT_CellContext

Method Detail

getCharTranslator

getHtmlElementTranslator

getPaddingBottom

getPaddingBottomChar

getPaddingLeft

getPaddingLeftChar

getPaddingRight

getPaddingRightChar

getPaddingTop

getPaddingTopChar

getTargetTranslator

getTextAlignment

setCharTranslator

setHtmlElementTranslator

setPadding

setPaddingBottom

setPaddingBottomChar

setPaddingLeft

setPaddingLeftChar

setPaddingLeftRight

setPaddingLeftRight

setPaddingRight

setPaddingRightChar

setPaddingTop

setPaddingTopBottom

setPaddingTopBottom

setPaddingTopChar

setTargetTranslator

setTextAlignment