WepsTable.dtd

WEPS Table XML Definition

Document Status : DRAFT

Author : Joseph Levin

Description: Defines the WepsTable xml "standard".

Document History

• Added a parent attribute to column, so I can enable column inheritence.
• Add a columnstyles element under table to contain the columns which may be inherited by other tables. This allows us to avoid inheriting column structure.
• Moved the format attribute out of displayunits and made it it's own element under data. This allows us to extend the format for strings or dates.

• Backtracked and put columngroup back in. They make the organization of a table easier to understand.
• Added lists of avaliable options for elements into the comments.
• Expanded the border element to include sides and color.
• Defined the column element and its children.

• Column group has been removed. The columns tag now serves as a grouping element.
• The cellstyle element has been shortended to style.
• Updated the label elements.

Root element of a WEPSTable.

<table>'s children Name Cardinality cellstyles One or none columnlabeldisplay One or none columns One or none columnstyles One or none defaultcellstyle One or none defaultlabelstyle One or none frozencolumns One or none frozenrows One or none rowlabeldisplay One or none

<table>'s attributes Name Values Default parent

(cellstyles?, columnstyles?, columns?, frozenrows?, frozencolumns?, defaultcellstyle?, defaultlabelstyle?, rowlabeldisplay?, columnlabeldisplay?)

The file name of a table to extend.

The cellstyles element contains the styles referenced by the table.

<cellstyles>'s children Name Cardinality style Any number

(style*)

The columnstyle elements contains the columns which may be inherited by other tables or columns.

<columnstyles>'s children Name Cardinality column Any number

(column*)

The columns elements contains the columns.

<columns>'s children Name Cardinality column Any number columngroup Any number

((columngroup | column)+)

Number of rows to freeze in the table.

Number of columns to freeze in the table.

Id of the cellstyle to use as a default for data cells in the table.

Id of the cellstyle to use as a default for label cells in the table.

Boolean value indicates if the table should display labels for each row.

Boolean value indicates if the table should display labels for each column.

Defines the label for a column or columns grouping element.

<label>'s children Name Cardinality image One or none style One or none text One or none

<label>'s attributes Name Values Default spancolumns spanrows

(text?, image?, style?)

Text data.

File name of an image.

<image>'s attributes Name Values Default rotate

Degress to rotate the image.

Override the default WepsTable spanning.

Override the default WepsTable spanning.

CellStyle Element

<style>'s children Name Cardinality background Any number border One or none editable One or none editor One or none font One or none foreground Any number horizontalalignment One or none renderer One or none repeatbackground One or none repeatforeground One or none traversable One or none verticalalignment One or none

(background*, foreground*, editable?, traversable?, horizontalalignment?, verticalalignment?, border?, font?, repeatbackground?, repeatforeground?, editor?, renderer?)

Background color of the cell. The value should be a hex code preceded with a # symbol. If the repeatbackground element is used then multiple background elements may be included.

Foreground color of the cell. The value should be a hex code preceded with a # symbol. If the repeatforeground element is used then multiple foreground elements may be included.

Boolean value indicating if the cells can be traversed.

Boolean value indicating if the cells can be edited by the user

Specifies the horizontal alignment of the cells.

Avaliable Horizontal Alignments

• LEFT
• CENTER
• RIGHT

Specifies the vertical alignment of the cells.

Avaliable Vertical Alignments

• TOP
• MIDDLE
• BOTTOM

Specifies the border style of the cells.

Avaliable Border Styles

• ETCHED_IN
• ETCHED_OUT
• FRAME_IN
• FRAME_OUT
• IN
• OUT
• PLAIN
• THIN
• NONE

<border>'s attributes Name Values Default all true, false bottom true, false color left true, false none true, false right true, false top true, false

Boolean, set to true to display a left border.

Possible values : true, false

Boolean, set to true to display a right border.

Possible values : true, false

Boolean, set to true to display a top border.

Possible values : true, false

Boolean, set to true to display a bottom border.

Possible values : true, false

Boolean, set to true to display a boder on all sides.

Possible values : true, false

Boolean, set to true to not display a border.

Possible values : true, false

Border color of the cell. The value should be a hex code preceded with a # symbol.

Specifies the font for the cells. The value should be the name of the font.

<font>'s attributes Name Values Default bold true, false italic true, false size

Point size for the font.

Boolean, set to true if the font is bold.

Possible values : true, false

Boolean, set to true if the font is italic.

Possible values : true, false

Specifies how to repeat the background colors of the table.

Avaliable Repeats

• NONE
• ROW
• COLUMN

Specifies how to repeat the foreground colors of the table.

Avaliable Repeats

• NONE
• ROW
• COLUMN

The editor element is intended to be a last resort when the WepsTable does not know how to present data to the user for editing. Include the full class path for the JCCellEditor.

Example :

<editor>com.klg.jclass.cell.editors.JCStringCellEditor</editor>

The renderer element is intended to be a last resort when the WepsTable does not know how to present data to the user.. Include the full class path for the JCCellRenderer.

Example :

<renderer>com.klg.jclass.cell.renderers.JCStringCellRenderer</renderer>

Unique id for the cell style. This allows cell styles or columns to extend the cell style.

Possible values : Match the ID rules.

Id of a cell style to extend. #cells or #labels will extend the default JCTable styles.

Possible values : Match the IDREF rules.

Columngroups allow for column spanning in the header of a WepsTable.

<columngroup>'s children Name Cardinality column Any number columngroup Any number label Any number

(label*, (columngroup | column)+)

Column Element

<column>'s children Name Cardinality action Any number data One or none label Any number style One or none width One or none

<column>'s attributes Name Values Default id Match the ID rules. parent Match the IDREF rules.

(label*, action*, data?, style?, width?)

Unique id for the column. This allows the column to be referenced.

Possible values : Match the ID rules.

Id of a column to inherit from. This column may be a previously defined column, a column in the columnstyles collection or a column in the columnstyles collection of parent tables.

Possible values : Match the IDREF rules.

Action code to return when an event is fired on the column. More than one action may be added to a column.

<action>'s attributes Name Values Default type

The type of action to respond to.

Avaliable Actions

• SINGLECLICK
• DOUBLECLICK

Container element for the details of the data contained in the column.

<data>'s children Name Cardinality adjust Any number displayunits Any number format Any number key One or none limit Any number list One or none units One or none value One or none

<data>'s attributes Name Values Default type

(key?, value?, units?, displayunits*, adjust*, limit*, list?, format*)

The type of data this column contains.

Avaliable Data Types

• TEXT
• MULTILINE
• NUMERIC
• BOOLEAN
• LIST
• IMAGE

The key is a string used to link the column to the datasource. It should be the label of column in the datasource. If omitted then the column id is used as the key.

Static value.

Measurement units that the data is stored in. NOTE: Only applies to NUMERIC columns.

Measurement units to display the data in for a given measurement system. NOTE: Only applies to NUMERIC columns.

<displayunits>'s attributes Name Values Default format system

The measurement unit system.

Possible Measurement Unit Systems

• SI
• US

Format mask to apply when displaying the data.

format Format mask to apply when displaying the data. NOTE: Only applies to NUMERIC columns.

<format>'s attributes Name Values Default system

The measurement unit system.

Possible Measurement Unit Systems

• SI
• US

Adjustment to apply to the data. You may add more than one adjustment. NOTE: Only applies to NUMERIC columns.

<adjust>'s attributes Name Values Default operation

The operation to use when applying the adjustment value.

Avaliable Operations

• ADD
• SUBTRACT
• MULTIPLY
• DIVIDE

Limit to apply when displaying the data. More than one limit may be applied. NOTE: Only applies to NUMERIC columns.

<limit>'s attributes Name Values Default allowzero true, false inclusive true, false text type

The measurement unit system.

Possible Limit Types

• LOWER
• UPPER

Boolean indicating if the bound is inclusive.

Possible values : true, false

String to display if the data is outside the limit. If omitted then a string is created using the limit type, inclusivity and the boundry value.

Boolean indicating if 0 will be displayed even if it is outside the limit boundry. Default is true.

Possible values : true, false

Defines the text to display for a given value. NOTE: Only applies to LIST columns.

<list>'s children Name Cardinality listitem Any number

(listitem*)

Sorry, no documentation.

<listitem>'s attributes Name Values Default value

The value to associate the listitem with.

Required

Width element

<width>'s attributes Name Values Default max min

The minimum width allowed.

The maximum width allowed.