Generic Docs Commodity Table (abstract)

From UG

(Difference between revisions)

Current revision as of 12:21, 5 August 2011

[edit] Parent Mantis

[edit] Technical Specification

[edit] Summary

This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.

Known sub-classes:

[edit] User Interface and Functionality

Template - see #Figure 1: Generic Docs Commodity Table Template.

Pdf - see #Figure 2: Generic Docs Commodity Table Pdf.

[edit] Line Manipulations

[edit] Definition

Line here is a horizontal block in a table, for example see #2 or #3 on #Figure 1: Generic Docs Commodity Table Template.

[edit] Line Up

Line could be selected and then moved up the list until top is reached
At first no line is selected
Once some line is selected system should hold selection until template is refreshed

[edit] Line Down

Line could be selected and then moved down the list until bottom is reached
At first no line is selected
Once some line is selected system should hold selection until template is refreshed

[edit] Insert Line

User selects line, clicks "Insert Blank Line"
System must insert line above selected
Once a line is selected system should hold selection until template is refreshed. This is more convenient if user wants to insert several lines at a time

[edit] Delete line

User can select lines and click "Delete". System would delete selected line and move all lines below one line up.
As usual keep selected line selected

[edit] Clear

User can select lines and click "Clear". All data will be cleared.

[edit] Errors

If user selects more than one line and clicks Line Up, Line Down or Delete then system must display Error in modal window: "Select only one line please!"

[edit] Sections

[edit] Header

See sec 1 on [#Figure 1: Generic Docs Commodity Table Template].

Has a check box to select all rows.

[edit] Columns

There could be any number of columns.

Additional functionality could be included - see child types/classes.

First column contains checkboxes that are used for row manipulation.

[edit] Cells

Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.

[edit] Rows

There could be any number of rows.

See [#Buttons] section for various operations you can perform with rows.

Additional functionality could be included - see child types/classes.

[edit] Totals

See sec 4 on [#Figure 1: Generic Docs Commodity Table Template].

If column contains data of numerical types then system must calculate and display read only total in textbox.

See Precision.

[edit] Special Cases: Multiple Pages

Print totals on every page??? TBD
see also Empty First Page (feature)

[edit] Look And Feel

See Figure 1,2.

Columns that contain alphanumeric data must be left aligned

Columns that contain numeric data must be right aligned (some include unit of measurement)

[edit] Figures

[edit] Figure 1: Generic Docs Commodity Table Template

[edit] Figure 2: Generic Docs Commodity Table Pdf

[edit] RFC

[edit] Known Non Critical Bugs and Issues

Do we want to have bar only above totals or across entire table

What is the Insert logic for fixed lines document (like HAWB)?
- option1) no Insert button
- option2) insert up to max# of lines and then display warning pop-up

[edit] History

[edit] Old spec

See Commodity Table for Pdfs

[edit] DB

@@ Line 1: / Line 1: @@
-[[Category: Ops Pdfs Common]]
+[[Category:OpsPdfsMisc]]
 == Parent Mantis ==
-[http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]
+[http://mantis.jaguarfreight.com/mantis/view.php?id=1698 1698]
-== Business Needs and Requirements ==
 == Technical Specification ==
 === Summary ===
+This is a super class for all Docs Commodity Tables. It has most generic functionality that is inherited by more specific tables.
+Known sub-classes:
+* [[Ocean Docs Commodity Table (feature)]]
+* [[Air Docs Commodity Table (feature)]]
 === User Interface and Functionality ===
+Template - see [[#Figure 1: Generic Docs Commodity Table Template]].
+Pdf - see [[#Figure 2: Generic Docs Commodity Table Pdf]].
+=== Line Manipulations ===
+==== Definition ====
+'''Line''' here is a horizontal block in a table, for example see #2 or #3 on [[#Figure 1: Generic Docs Commodity Table Template]].
 ==== Line Up ====
@@ Line 16: / Line 32: @@
 * Line could be selected and then moved up the list until top is reached
 * At first no line is selected
-* Once some line is selected system should hold selection until page is refreshed or another line is selected (not working now)
+* Once some line is selected system should hold selection until template is refreshed
 ==== Line Down ====
-* 1  Line could be selected and then moved down the list until bottom is reached
+* Line could be selected and then moved down the list until bottom is reached
-* 2  Some documents have no bottom (if they could be multipage, example: DO.Ocean), some have (DO.Air)
+* At first no line is selected
-* 3  At first no line is selected
+* Once some line is selected system should hold selection until template is refreshed
-* 4  Once some line is selected system should hold selection until page is refreshed or another line is selected
 ==== Insert Line ====
-* 1 user selects line, clicks "Insert"
-* 2 system must insert line above selected
+* User selects line, clicks "Insert Blank Line"
-* 3 system must keep selected line selected even after insert - this is more convenient if user wants to insert several lines at a time
+* System must insert line '''above''' selected
-* 4 what is the Insert logic for fixed lines document (like HAWB)?
+* Once a line is selected system should hold selection until template is refreshed. This is more convenient if user wants to insert several lines at a time
-** option1) no Insert button
-** option2) insert up to max# of lines and then display warning pop-up
 ==== Delete line ====
-* 1 User can select line and click "Delete". System would delete selected line and move all lines below one line up.
+* User can select lines and click "Delete". System would delete selected line and move all lines below one line up.
-* 2 As usual keep selected line selected
+* As usual keep selected line selected
+==== Clear ====
+* User can select lines and click "Clear". All data will be cleared.
-=== Entities and Attributes ===
+==== Errors ====
-=== Special Cases and Misc ===
+If user selects more than one line and clicks Line Up, Line Down or Delete then system must display Error in modal window: "Select only one line please!"
+=== Sections ===
+==== Header ====
+* See sec 1 on [#Figure 1: Generic Docs Commodity Table Template].
+* Has a check box to select all rows.
+==== Columns ====
+There could be any number of columns.
+Additional functionality could be included - see child types/classes.
+First column contains checkboxes that are used for row manipulation.
+==== Cells ====
+Inside of every cell on template we could have textbox, textarea, etc. Data type could be string, number, etc.
+==== Rows ====
+There could be any number of rows.
+See [#Buttons] section for various operations you can perform with rows.
+Additional functionality could be included - see child types/classes.
+==== Totals ====
+See sec 4 on [#Figure 1: Generic Docs Commodity Table Template].
+If column contains data of numerical types then system must calculate and display read only total in [[textbox]].
+See [[Precision]].
+=== Special Cases: Multiple Pages ===
+*
+* Print totals on every page??? TBD
+* see also [[Empty First Page (feature)]]
 === Look And Feel ===
+* See Figure 1,2.
+* Columns that contain alphanumeric data must be left aligned
+* Columns that contain numeric data must be right aligned (some include unit of measurement)
 === Figures ===
@@ Line 61: / Line 125: @@
 * Do we want to have bar only above totals or across entire table
+* What is the Insert logic for fixed lines document (like HAWB)?
+** option1) no Insert button
+** option2) insert up to max# of lines and then display warning pop-up
 == History ==