nextapp.echoservlet.ui
Class TriCellTable

java.lang.Object
  nextapp.echoservlet.html.Element
      nextapp.echoservlet.ui.TriCellTable

All Implemented Interfaces:

Renderable, java.io.Serializable

class TriCellTable

extends Element

Renders an HTML table that has two or three "container" cells and independently settable margins between them. These tables are useful for rendering buttons that have two or three elements (images, text labels, and state indicators). This class supports all possible permutations for placement of each of the two or three contained components.

Field Summary

(package private) static int	BOTTOM_TOP
(package private) static int	INVERTED
(package private) static int	LEFT_RIGHT
private Element[]	marginTds
(package private) static int	RIGHT_LEFT
private Element[]	tds
(package private) static int	TOP_BOTTOM
(package private) static int	VERTICAL

Fields inherited from class nextapp.echoservlet.html.Element

Fields inherited from interface nextapp.echoservlet.html.Renderable

INDENT_STRING

Constructor Summary

private	TriCellTable() This constructor is called by the non-private constructors to set up common properties.
(package private)	TriCellTable(Connection conn, int orientation0_1, int margin0_1) Creates a two-celled TriCellTable.
(package private)	TriCellTable(Connection conn, int orientation0_1, int margin0_1, int orientation01_2, int margin01_2) Creates a three-celled TriCellTable.

Method Summary

private void	addColumn(Element tr, Element td) Adds an cell element to a table row.
void	addGlobalAttribute(java.lang.String name, java.lang.String value) Adds an attribute to every table cell in the rendered table.
private void	addRow(Element td) Adds a row containing a single column element to a table.
(package private) Element	getMarginTdElement(int index) Returns the specified margin element.
(package private) static int	getOrientation(int horizontalOrientation, int verticalOrientation) Translates horizontal and vertical orientation constants from the nextapp.echo.EchoContstants class into the constants used by TriCellTable: LEFT_RIGHT RIGHT_LEFT TOP_BOTTOM BOTTOM_TOP
(package private) Element	getTdElement(int index) Returns the specified container element.

Methods inherited from class nextapp.echoservlet.html.Element

add, add, addAttribute, addAttribute, addAttribute, addElement, addElement, addElementContent, addElementContent, addHtml, addHtml, addText, addText, addText, getAttribute, getName, indexOf, isSticky, render, render, setClosingTagRequired, setSticky, setWhitespaceRelevant

Methods inherited from class java.lang.Object

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

Field Detail

INVERTED

static final int INVERTED

See Also:

Constant Field Values

VERTICAL

static final int VERTICAL

See Also:

Constant Field Values

LEFT_RIGHT

static final int LEFT_RIGHT

See Also:

Constant Field Values

RIGHT_LEFT

static final int RIGHT_LEFT

See Also:

Constant Field Values

TOP_BOTTOM

static final int TOP_BOTTOM

See Also:

Constant Field Values

BOTTOM_TOP

static final int BOTTOM_TOP

See Also:

Constant Field Values

tds

private Element[] tds

marginTds

private Element[] marginTds

Constructor Detail

TriCellTable

private TriCellTable()

This constructor is called by the non-private constructors to set up common properties.

TriCellTable

TriCellTable(Connection conn,
             int orientation0_1,
             int margin0_1)

Creates a two-celled TriCellTable.

Parameters:

conn - The connection which is to render the underlying button object.

orientation0_1 - The orientation of Element 0 with respect to Element 1, one of the following values:

• LEFT_RIGHT (element 0 is to the left of element 1)
• RIGHT_LEFT (element 1 is to the left of element 0)
• TOP_BOTTOM (element 0 is above element 1)
• BOTTOM_TOP (element 1 is above element 0)

margin0_1 - The margin size (in pixels) between element 0 and element 1.

TriCellTable

TriCellTable(Connection conn,
             int orientation0_1,
             int margin0_1,
             int orientation01_2,
             int margin01_2)

Creates a three-celled TriCellTable.

Parameters:

conn - The connection which is to render the underlying button object.

orientation0_1 - The orientation of Element 0 with respect to Element 1, one of the following values:

• LEFT_RIGHT (element 0 is to the left of element 1)
• RIGHT_LEFT (element 1 is to the left of element 0)
• TOP_BOTTOM (element 0 is above element 1)
• BOTTOM_TOP (element 1 is above element 0)

margin0_1 - The margin size (in pixels) between element 0 and element 1.

orientation01_2 - The orientation of Elements 0 and 1 with respect to Element 2, one of the following values:

• LEFT_RIGHT (elements 0 and 1 are to the left of element 1)
• RIGHT_LEFT (element 2 is to the left of elements 0 and 1)
• TOP_BOTTOM (elements 0 and 1 are above element 2)
• BOTTOM_TOP (element 2 is above elements 0 and 1)

margin01_2 - The margin size (in pixels) between the combination of elements 0 and 1 and element 2. element 1.

Method Detail

getOrientation

static int getOrientation(int horizontalOrientation,
                          int verticalOrientation)

Translates horizontal and vertical orientation constants from the nextapp.echo.EchoContstants class into the constants used by TriCellTable:

• LEFT_RIGHT
• RIGHT_LEFT
• TOP_BOTTOM
• BOTTOM_TOP

Parameters:

horizontalOrientation - The horizontal orientation desired, one of the following values:

• EchoConstants.LEFT
• EchoConstants.CENTER
• EchoConstants.RIGHT

verticalOrientation - The vertical orientation desired, one of the following values:

• EchoConstants.TOP
• EchoConstants.CENTER
• EchoConstants.BOTTOM

Returns:

Am orientation constant from TriCellTable that equates to the orientation parameters provided.

addColumn

private void addColumn(Element tr,
                       Element td)

Adds an cell element to a table row. The element will not be added if null is provided for the value of td.

Parameters:

tr - The table row to which the cell element is to be added.

td - The cell element to be added (if not null).

addGlobalAttribute

public void addGlobalAttribute(java.lang.String name,
                               java.lang.String value)

Adds an attribute to every table cell in the rendered table.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

addRow

private void addRow(Element td)

Adds a row containing a single column element to a table. The row will not be added if td is null.

Parameters:

td - The cell element to be added.

getTdElement

Element getTdElement(int index)

Returns the specified container element.

Parameters:

index - The index of the table element to return. For two-celled tables, legitimate values are 0 and 1. For three-celled tables, legitimate values are 0, 1, and 2.

Returns:

The specified container element.

getMarginTdElement

Element getMarginTdElement(int index)

Returns the specified margin element.

Parameters:

index - The index of the table element to return. Index 0 is the margin element between container cells 0 and 1. Index 1 is the margin element between container cells 0/1 and 2.

Returns:

The specified margin element. Returns null if the margin is zero pixels.