net.sourceforge.taglets.demo.inline
Class Table

java.lang.Object
  net.sourceforge.taglets.demo.inline.Table

public class Table
extends Object

Demonstration of the table inline tag.

This demo class shows how to use the table inline tag.

Instead of fiddling with HTML tables in JavaDoc source code the table inline tags allows for nicely readable tables, esp. when using a monospaced font to edit the source code.

The @table tag is handy to create M*N tables and is used as follows:

Table Tag Syntax

{@table [noheader] [nofill]
  || header 1 | header 2 | ... | header N ||
  || cell 1/1 | cell 1/2 | ... | cell 1/N ||
  || cell 2/1 | cell 2/2 | ... | cell 2/N ||
  ...
  || cell M/1 | cell M/2 | ... | cell M/N ||
}

Customization

In the default configuration the @table tag uses bold header text with a dark background. Table rows use an alternating background color. You can easily change the default style or introduce new table tags with different CSS styles via the taglets configuration.

Version:

1.3 (2008/03/30 12:43:17)

Maintainer:

Bruno Essmann <essmann@sourceforge.net>

Since:

1.9.2

Constructor Summary

Table()

Method Summary

void	defaultTable() Table with header that uses up the available browser width.
void	noFill() Table with header that only uses the required width.
void	noHeader() Table without header that uses up the available browser width.
void	noHeaderNoFill() Table without header that only uses the required width.

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table()

Method Detail

defaultTable

public void defaultTable()

Table with header that uses up the available browser width.

The following inline tag produces the table shown below:

{@table
  || header 1 | header 2 | header 3 | header 4 | header 5 ||
  || cell 1/1 | cell 1/2 | cell 1/3 | cell 1/4 | cell 1/5 ||
  || cell 2/1 | cell 2/2 | cell 2/3 | cell 2/4 | cell 2/5 ||
  || cell 3/1 | cell 3/2 | cell 3/3 | cell 3/4 | cell 3/5 ||
  || cell 4/1 | cell 4/2 | cell 4/3 | cell 4/4 | cell 4/5 ||
}

header 1	header 2	header 3	header 4	header 5
cell 1/1	cell 1/2	cell 1/3	cell 1/4	cell 1/5
cell 2/1	cell 2/2	cell 2/3	cell 2/4	cell 2/5
cell 3/1	cell 3/2	cell 3/3	cell 3/4	cell 3/5
cell 4/1	cell 4/2	cell 4/3	cell 4/4	cell 4/5

Since:

1.9.2

noHeader

public void noHeader()

Table without header that uses up the available browser width.

The following inline tag produces the table shown below:

{@table noheader
  || cell 1/1 | cell 1/2 | cell 1/3 | cell 1/4 | cell 1/5 ||
  || cell 2/1 | cell 2/2 | cell 2/3 | cell 2/4 | cell 2/5 ||
  || cell 3/1 | cell 3/2 | cell 3/3 | cell 3/4 | cell 3/5 ||
  || cell 4/1 | cell 4/2 | cell 4/3 | cell 4/4 | cell 4/5 ||
}

cell 1/1	cell 1/2	cell 1/3	cell 1/4	cell 1/5
cell 2/1	cell 2/2	cell 2/3	cell 2/4	cell 2/5
cell 3/1	cell 3/2	cell 3/3	cell 3/4	cell 3/5
cell 4/1	cell 4/2	cell 4/3	cell 4/4	cell 4/5

Since:

1.9.2

noFill

public void noFill()

Table with header that only uses the required width.

The following inline tag produces the table shown below:

{@table nofill
  || header 1 | header 2 | header 3 | header 4 | header 5 ||
  || cell 1/1 | cell 1/2 | cell 1/3 | cell 1/4 | cell 1/5 ||
  || cell 2/1 | cell 2/2 | cell 2/3 | cell 2/4 | cell 2/5 ||
  || cell 3/1 | cell 3/2 | cell 3/3 | cell 3/4 | cell 3/5 ||
  || cell 4/1 | cell 4/2 | cell 4/3 | cell 4/4 | cell 4/5 ||
}

header 1	header 2	header 3	header 4	header 5
cell 1/1	cell 1/2	cell 1/3	cell 1/4	cell 1/5
cell 2/1	cell 2/2	cell 2/3	cell 2/4	cell 2/5
cell 3/1	cell 3/2	cell 3/3	cell 3/4	cell 3/5
cell 4/1	cell 4/2	cell 4/3	cell 4/4	cell 4/5

Since:

1.9.2

noHeaderNoFill

public void noHeaderNoFill()

Table without header that only uses the required width.

The following inline tag produces the table shown below:

{@table noheader nofill
  || cell 1/1 | cell 1/2 | cell 1/3 | cell 1/4 | cell 1/5 ||
  || cell 2/1 | cell 2/2 | cell 2/3 | cell 2/4 | cell 2/5 ||
  || cell 3/1 | cell 3/2 | cell 3/3 | cell 3/4 | cell 3/5 ||
  || cell 4/1 | cell 4/2 | cell 4/3 | cell 4/4 | cell 4/5 ||
}

cell 1/1	cell 1/2	cell 1/3	cell 1/4	cell 1/5
cell 2/1	cell 2/2	cell 2/3	cell 2/4	cell 2/5
cell 3/1	cell 3/2	cell 3/3	cell 3/4	cell 3/5
cell 4/1	cell 4/2	cell 4/3	cell 4/4	cell 4/5

Since:

1.9.2