Merge pull request #1510 from pavelbraginskiy/rowshading

Improve readability of tables
MegaMek · May 22, 2024 · 5b1e7c7 · 5b1e7c7
2 parents ce00161 + c235a8a
commit 5b1e7c7
Show file tree

Hide file tree

Showing 40 changed files with 135,301 additions and 54,668 deletions.
diff --git a/megameklab/data/images/recordsheets/templates_iso/battle_armor_default.svg b/megameklab/data/images/recordsheets/templates_iso/battle_armor_default.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/conventional_infantry_tables.svg b/megameklab/data/images/recordsheets/templates_iso/conventional_infantry_tables.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/fighter_conventional_default.svg b/megameklab/data/images/recordsheets/templates_iso/fighter_conventional_default.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_dualturret_standard.svg b/megameklab/data/images/recordsheets/templates_iso/naval_dualturret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_dualturret_superheavy.svg b/megameklab/data/images/recordsheets/templates_iso/naval_dualturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_noturret_standard.svg b/megameklab/data/images/recordsheets/templates_iso/naval_noturret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_noturret_superheavy.svg b/megameklab/data/images/recordsheets/templates_iso/naval_noturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_turret_standard.svg b/megameklab/data/images/recordsheets/templates_iso/naval_turret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/naval_turret_superheavy.svg b/megameklab/data/images/recordsheets/templates_iso/naval_turret_superheavy.svg
diff --git a/...meklab/data/images/recordsheets/templates_iso/submarine_dualturret_standard.svg b/...meklab/data/images/recordsheets/templates_iso/submarine_dualturret_standard.svg
diff --git a/...klab/data/images/recordsheets/templates_iso/submarine_dualturret_superheavy.svg b/...klab/data/images/recordsheets/templates_iso/submarine_dualturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/submarine_noturret_standard.svg b/megameklab/data/images/recordsheets/templates_iso/submarine_noturret_standard.svg
diff --git a/...meklab/data/images/recordsheets/templates_iso/submarine_noturret_superheavy.svg b/...meklab/data/images/recordsheets/templates_iso/submarine_noturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/submarine_turret_standard.svg b/megameklab/data/images/recordsheets/templates_iso/submarine_turret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/submarine_turret_superheavy.svg b/megameklab/data/images/recordsheets/templates_iso/submarine_turret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/tables_tank.svg b/megameklab/data/images/recordsheets/templates_iso/tables_tank.svg
diff --git a/megameklab/data/images/recordsheets/templates_iso/tables_vtol.svg b/megameklab/data/images/recordsheets/templates_iso/tables_vtol.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/battle_armor_default.svg b/megameklab/data/images/recordsheets/templates_us/battle_armor_default.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/conventional_infantry_tables.svg b/megameklab/data/images/recordsheets/templates_us/conventional_infantry_tables.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/fighter_conventional_default.svg b/megameklab/data/images/recordsheets/templates_us/fighter_conventional_default.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_dualturret_standard.svg b/megameklab/data/images/recordsheets/templates_us/naval_dualturret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_dualturret_superheavy.svg b/megameklab/data/images/recordsheets/templates_us/naval_dualturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_noturret_standard.svg b/megameklab/data/images/recordsheets/templates_us/naval_noturret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_noturret_superheavy.svg b/megameklab/data/images/recordsheets/templates_us/naval_noturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_turret_standard.svg b/megameklab/data/images/recordsheets/templates_us/naval_turret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/naval_turret_superheavy.svg b/megameklab/data/images/recordsheets/templates_us/naval_turret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/submarine_dualturret_standard.svg b/megameklab/data/images/recordsheets/templates_us/submarine_dualturret_standard.svg
diff --git a/...eklab/data/images/recordsheets/templates_us/submarine_dualturret_superheavy.svg b/...eklab/data/images/recordsheets/templates_us/submarine_dualturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/submarine_noturret_standard.svg b/megameklab/data/images/recordsheets/templates_us/submarine_noturret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/submarine_noturret_superheavy.svg b/megameklab/data/images/recordsheets/templates_us/submarine_noturret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/submarine_turret_standard.svg b/megameklab/data/images/recordsheets/templates_us/submarine_turret_standard.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/submarine_turret_superheavy.svg b/megameklab/data/images/recordsheets/templates_us/submarine_turret_superheavy.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/tables_tank.svg b/megameklab/data/images/recordsheets/templates_us/tables_tank.svg
diff --git a/megameklab/data/images/recordsheets/templates_us/tables_vtol.svg b/megameklab/data/images/recordsheets/templates_us/tables_vtol.svg
diff --git a/megameklab/resources/megameklab/resources/Dialogs.properties b/megameklab/resources/megameklab/resources/Dialogs.properties
@@ -24,6 +24,9 @@ ConfigurationDialog.cbPaper.text=Paper Size:
 ConfigurationDialog.cbPaper.tooltip=<html>The dimensions of the page to use when exporting to PDF.<br/>When printing, this can be changed in the print dialog.</html>
 ConfigurationDialog.chkColor.text=Use color
 ConfigurationDialog.chkColor.tooltip=Use color on the record sheet.
+ConfigurationDialog.chkRowShading.text=Improve table readability
+ConfigurationDialog.chkRowShading.tooltip=<html>Add grey shading to alternating rows of certain tables to make them more readable.<br/>\
+  WARNING: Significantly slows down record sheet export.</html>
 ConfigurationDialog.cbFont.text=Font Family:
 ConfigurationDialog.cbFont.tooltip=<html>Select the typeface to use when printing record sheets.<br/>\
   Additional truetype fonts can be made available to MML by placing the font file in the data/fonts directory.</html>

diff --git a/megameklab/src/megameklab/printing/IdConstants.java b/megameklab/src/megameklab/printing/IdConstants.java
@@ -28,6 +28,7 @@ public interface IdConstants {
     String COPYRIGHT = "tspanCopyright";
     String TITLE = "title";
     String UNIT_SCALE = "unitScale";
+    String ROW_SHADING = "tableshading";
 
     String TYPE = "type";
     String TYPE2 = "type2";

diff --git a/megameklab/src/megameklab/printing/PrintRecordSheet.java b/megameklab/src/megameklab/printing/PrintRecordSheet.java
@@ -221,6 +221,10 @@ private void subColorElements() {
         }
     }
 
+    private void shadeTableRows() {
+        hideElement(ROW_SHADING, !options.useRowShading());
+    }
+
     /**
      * Creates a {@link Document} from an svg image file
      *
@@ -290,6 +294,7 @@ protected boolean createDocument(int pageIndex, PageFormat pageFormat, boolean a
         }
         subFonts((SVGDocument) getSVGDocument());
         subColorElements();
+        shadeTableRows();
         SVGGeneratorContext context = SVGGeneratorContext.createDefault(getSVGDocument());
         svgGenerator = new SVGGraphics2D(context, false);
         double ratio = Math.min(pageFormat.getImageableWidth() / (options.getPaperSize().pxWidth - 36),

diff --git a/megameklab/src/megameklab/printing/RecordSheetOptions.java b/megameklab/src/megameklab/printing/RecordSheetOptions.java
@@ -34,6 +34,7 @@ public class RecordSheetOptions {
     private boolean eraBasedProgression;
     private boolean referenceCharts;
     private boolean condensedReferenceCharts;
+    private boolean rowShading;
 
     public RecordSheetOptions() {
         String paper = CConfig.getParam(CConfig.RS_PAPER_SIZE, PaperSize.US_LETTER.name());
@@ -52,6 +53,7 @@ public RecordSheetOptions() {
         this.eraBasedProgression = CConfig.getBooleanParam(CConfig.TECH_PROGRESSION);
         this.referenceCharts = CConfig.getBooleanParam(CConfig.RS_REFERENCE);
         this.condensedReferenceCharts = CConfig.getBooleanParam(CConfig.RS_CONDENSED_REFERENCE);
+        this.rowShading = CConfig.getBooleanParam(CConfig.RS_ROW_SHADING);
     }
 
     public RecordSheetOptions(RecordSheetOptions options) {
@@ -66,6 +68,7 @@ public RecordSheetOptions(RecordSheetOptions options) {
         eraBasedProgression = options.eraBasedProgression;
         referenceCharts = options.referenceCharts;
         condensedReferenceCharts = options.condensedReferenceCharts;
+        rowShading = options.rowShading;
     }
 
     public PaperSize getPaperSize() {
@@ -116,6 +119,10 @@ public boolean showCondensedReferenceCharts() {
         return condensedReferenceCharts;
     }
 
+    public boolean useRowShading() {
+        return rowShading;
+    }
+
     public void setPaperSize(PaperSize paperSize) {
         this.paperSize = paperSize;
     }
@@ -151,4 +158,8 @@ public void setReferenceCharts(boolean charts) {
     public void setCondensedReferenceCharts(boolean charts) {
         this.condensedReferenceCharts = charts;
     }
+
+    public void setRowShading(boolean rowShading) {
+        this.rowShading = rowShading;
+    }
 }
diff --git a/megameklab/src/megameklab/ui/dialog/settings/ExportSettingsPanel.java b/megameklab/src/megameklab/ui/dialog/settings/ExportSettingsPanel.java
@@ -57,6 +57,7 @@ class ExportSettingsPanel extends JPanel {
     private final IntRangeTextField txtScale = new IntRangeTextField(3);
     private final MMComboBox<MekChassisArrangement> mekChassis =
             new MMComboBox<>("Mek Names", MekChassisArrangement.values());
+    private final JCheckBox chkRowShading = new JCheckBox();
 
     ExportSettingsPanel() {
         ResourceBundle resourceMap = ResourceBundle.getBundle("megameklab.resources.Dialogs");
@@ -102,6 +103,10 @@ class ExportSettingsPanel extends JPanel {
         chkColor.setToolTipText(resourceMap.getString("ConfigurationDialog.chkColor.tooltip"));
         chkColor.setSelected(CConfig.getBooleanParam(CConfig.RS_COLOR));
 
+        chkRowShading.setText(resourceMap.getString("ConfigurationDialog.chkRowShading.text"));
+        chkRowShading.setToolTipText(resourceMap.getString("ConfigurationDialog.chkRowShading.tooltip"));
+        chkRowShading.setSelected(CConfig.getBooleanParam(CConfig.RS_ROW_SHADING));
+
         chkShowReferenceTables.setText(resourceMap.getString("ConfigurationDialog.chkShowReferenceTables.text"));
         chkShowReferenceTables.setToolTipText(resourceMap.getString("ConfigurationDialog.chkShowReferenceTables.tooltip"));
         chkShowReferenceTables.setSelected(CConfig.getBooleanParam(CConfig.RS_REFERENCE));
@@ -169,6 +174,7 @@ class ExportSettingsPanel extends JPanel {
         gridPanel.add(paperPanel);
         gridPanel.add(fontPanel);
         gridPanel.add(chkColor);
+        gridPanel.add(chkRowShading);
         gridPanel.add(chkShowReferenceTables);
         gridPanel.add(chkShowCondensedTables);
         gridPanel.add(chkShowQuirks);
@@ -179,7 +185,7 @@ class ExportSettingsPanel extends JPanel {
         gridPanel.add(chkTacOpsHeat);
         gridPanel.add(mekNameLine);
         gridPanel.add(scalePanel);
-        SpringUtilities.makeCompactGrid(gridPanel, 14, 1, 0, 0, 15, 10);
+        SpringUtilities.makeCompactGrid(gridPanel, 15, 1, 0, 0, 15, 8);
         gridPanel.setBorder(new EmptyBorder(20, 30, 20, 30));
         setLayout(new FlowLayout(FlowLayout.LEFT));
         add(gridPanel);
@@ -191,6 +197,7 @@ Map<String, String> getRecordSheetSettings() {
         recordSheetSettings.put(CConfig.RS_FONT, (String) cbFont.getSelectedItem());
         recordSheetSettings.put(CConfig.RS_PROGRESS_BAR, String.valueOf(chkProgressBar.isSelected()));
         recordSheetSettings.put(CConfig.RS_COLOR, Boolean.toString(chkColor.isSelected()));
+        recordSheetSettings.put(CConfig.RS_ROW_SHADING, Boolean.toString(chkRowShading.isSelected()));
         recordSheetSettings.put(CConfig.RS_REFERENCE, Boolean.toString(chkShowReferenceTables.isSelected()));
         recordSheetSettings.put(CConfig.RS_CONDENSED_REFERENCE, Boolean.toString(chkShowCondensedTables.isSelected()));
         recordSheetSettings.put(CConfig.RS_SHOW_QUIRKS, Boolean.toString(chkShowQuirks.isSelected()));

diff --git a/megameklab/src/megameklab/util/CConfig.java b/megameklab/src/megameklab/util/CConfig.java
@@ -88,6 +88,7 @@ public final class CConfig {
 
     public static final String RS_PAPER_SIZE = "rs_paper_size";
     public static final String RS_COLOR = "rs_color";
+    public static final String RS_ROW_SHADING = "rs_row_shading";
     public static final String RS_FONT = "rs_font";
     public static final String RS_PROGRESS_BAR = "rs_progress_bar";
     public static final String RS_SHOW_QUIRKS = "rs_show_quirks";