Expand row and col styling via sub components

This commit is contained in:
TheStonedTurtle
2019-04-30 23:48:41 -07:00
parent 8595713d3d
commit c1dddcb881
4 changed files with 194 additions and 41 deletions

View File

@@ -0,0 +1,8 @@
package net.runelite.client.ui.overlay.components.table;
public enum TableAlignment
{
LEFT,
CENTER,
RIGHT
}

View File

@@ -23,7 +23,7 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
package net.runelite.client.ui.overlay.components; package net.runelite.client.ui.overlay.components.table;
import java.awt.Color; import java.awt.Color;
import java.awt.Dimension; import java.awt.Dimension;
@@ -32,34 +32,27 @@ import java.awt.Graphics2D;
import java.awt.Point; import java.awt.Point;
import java.awt.Rectangle; import java.awt.Rectangle;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
import lombok.AccessLevel; import javax.annotation.Nullable;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
import net.runelite.client.ui.overlay.components.ComponentConstants;
import net.runelite.client.ui.overlay.components.LayoutableRenderableEntity;
import net.runelite.client.ui.overlay.components.TextComponent;
@Setter @Setter
public class TableComponent implements LayoutableRenderableEntity public class TableComponent implements LayoutableRenderableEntity
{ {
public enum TableAlignment private static final TableRow EMPTY_ROW = TableRow.builder().build();
{ private static final TableElement EMPTY_ELEMENT = TableElement.builder().build();
LEFT,
CENTER,
RIGHT
}
@Getter @Getter
private final Rectangle bounds = new Rectangle(); private final Rectangle bounds = new Rectangle();
@Setter(AccessLevel.NONE)
private ArrayList<String[]> cells = new ArrayList<>();
@Nonnull @Nonnull
private TableAlignment[] columnAlignments = new TableAlignment[0]; private TableElement[] tableColumns = new TableElement[0];
@Nonnull private final List<TableRow> tableRows = new ArrayList<>();
private Color[] columnColors = new Color[0];
@Setter(AccessLevel.NONE)
private int numCols;
@Setter(AccessLevel.NONE)
private int numRows;
@Nonnull @Nonnull
private TableAlignment defaultAlignment = TableAlignment.LEFT; private TableAlignment defaultAlignment = TableAlignment.LEFT;
@@ -81,6 +74,9 @@ public class TableComponent implements LayoutableRenderableEntity
graphics.translate(preferredLocation.x, preferredLocation.y); graphics.translate(preferredLocation.x, preferredLocation.y);
final int numRows = tableRows.size();
final int numCols = tableColumns.length;
for (int row = 0; row < numRows; row++) for (int row = 0; row < numRows; row++)
{ {
int x = 0; int x = 0;
@@ -91,13 +87,16 @@ public class TableComponent implements LayoutableRenderableEntity
final String[] lines = lineBreakText(getCellText(col, row), columnWidths[col], metrics); final String[] lines = lineBreakText(getCellText(col, row), columnWidths[col], metrics);
for (String line : lines) for (String line : lines)
{ {
final int alignmentOffset = getAlignedPosition(line, getColumnAlignment(col), columnWidths[col], metrics); final TableAlignment alignment = getCellAlignment(row, col);
final int alignmentOffset = getAlignedPosition(line, alignment, columnWidths[col], metrics);
final TextComponent leftLineComponent = new TextComponent(); final TextComponent leftLineComponent = new TextComponent();
y += metrics.getHeight(); y += metrics.getHeight();
final Color lineColor = getCellColor(row, col);
leftLineComponent.setPosition(new Point(x + alignmentOffset, y)); leftLineComponent.setPosition(new Point(x + alignmentOffset, y));
leftLineComponent.setText(line); leftLineComponent.setText(line);
leftLineComponent.setColor(getColumnColor(col)); leftLineComponent.setColor(lineColor);
leftLineComponent.render(graphics); leftLineComponent.render(graphics);
} }
height = Math.max(height, y); height = Math.max(height, y);
@@ -115,21 +114,28 @@ public class TableComponent implements LayoutableRenderableEntity
public void setColumnColor(final int col, final Color color) public void setColumnColor(final int col, final Color color)
{ {
assert columnColors.length > col; assert tableColumns.length > col;
columnColors[col] = color; tableColumns[col].setColor(color);
} }
public void setColumnAlignment(final int col, final TableAlignment alignment) public void setColumnAlignment(final int col, final TableAlignment alignment)
{ {
assert columnAlignments.length > col; assert tableColumns.length > col;
columnAlignments[col] = alignment; tableColumns[col].setAlignment(alignment);
} }
public void addRow(@Nonnull final String... cells) public void addRow(@Nonnull final String... cells)
{ {
numCols = Math.max(numCols, cells.length); final TableElement[] elements = new TableElement[cells.length];
numRows++; for (int i = 0; i < cells.length; i++)
this.cells.add(cells); {
elements[i] = TableElement.builder().content(cells[i]).build();
}
final TableRow row = TableRow.builder().build();
row.setElements(elements);
this.tableRows.add(row);
} }
public void addRows(@Nonnull final String[]... rows) public void addRows(@Nonnull final String[]... rows)
@@ -140,39 +146,43 @@ public class TableComponent implements LayoutableRenderableEntity
} }
} }
private Color getColumnColor(final int column) public void addRow(@Nonnull TableRow row)
{ {
if (columnColors.length <= column this.tableRows.add(row);
|| columnColors[column] == null)
{
return defaultColor;
}
return columnColors[column];
} }
private TableAlignment getColumnAlignment(final int column) public void addRows(@Nonnull final TableRow... rows)
{ {
if (columnAlignments.length <= column for (TableRow row : rows)
|| columnAlignments[column] == null)
{ {
return defaultAlignment; addRow(row);
} }
return columnAlignments[column];
} }
private String getCellText(final int col, final int row) private String getCellText(final int col, final int row)
{ {
assert col < numCols && row < numRows; assert col < tableColumns.length && row < tableRows.size();
if (cells.get(row).length < col) if (row == -1)
{
return tableColumns[col].getContent();
}
TableElement[] elements = tableRows.get(row).getElements();
if (col >= elements.length)
{ {
return ""; return "";
} }
return cells.get(row)[col];
final String result = elements[col].content;
return result != null ? result : "";
} }
private int[] getColumnWidths(final FontMetrics metrics) private int[] getColumnWidths(final FontMetrics metrics)
{ {
final int numRows = tableRows.size();
final int numCols = tableColumns.length;
// Based on https://stackoverflow.com/questions/22206825/algorithm-for-calculating-variable-column-widths-for-set-table-width // Based on https://stackoverflow.com/questions/22206825/algorithm-for-calculating-variable-column-widths-for-set-table-width
int[] maxtextw = new int[numCols]; // max text width over all rows int[] maxtextw = new int[numCols]; // max text width over all rows
int[] maxwordw = new int[numCols]; // max width of longest word int[] maxwordw = new int[numCols]; // max width of longest word
@@ -331,4 +341,63 @@ public class TableComponent implements LayoutableRenderableEntity
} }
return offset; return offset;
} }
private Color getCellColor(final int row, final int column)
{
assert row < tableRows.size() && column < tableColumns.length;
// Row should be -1 for columns so use a empty TableRow
final TableRow rowEle = row != -1 ? tableRows.get(row) : EMPTY_ROW;
final TableElement columnElement = tableColumns[column];
final TableElement[] elements = rowEle.getElements();
// Some rows may not have every element, even though they should..
final TableElement ele = column < elements.length ? elements[column] : EMPTY_ELEMENT;
// Color priorities goes as follow: cell->row->column->default
return firstNonNull(
ele.getColor(),
rowEle.getRowColor(),
columnElement.getColor(),
defaultColor);
}
private TableAlignment getCellAlignment(final int row, final int column)
{
assert row < tableRows.size() && column < tableColumns.length;
// Row should be -1 for columns so use a empty TableRow
final TableRow rowEle = row != -1 ? tableRows.get(row) : EMPTY_ROW;
final TableElement columnElement = tableColumns[column];
final TableElement[] elements = rowEle.getElements();
// Some rows may not have every element, even though they should..
final TableElement ele = column < elements.length ? elements[column] : EMPTY_ELEMENT;
// Alignment priorities goes as follow: cell->row->column->default
return firstNonNull(
ele.getAlignment(),
rowEle.getRowAlignment(),
columnElement.getAlignment(),
defaultAlignment);
}
@SafeVarargs
private static <T> T firstNonNull(@Nullable T... elements)
{
if (elements == null || elements.length == 0)
{
return null;
}
int i = 0;
T cur = elements[0];
while (cur == null && i < elements.length)
{
cur = elements[i];
i++;
}
return cur;
}
} }

View File

@@ -0,0 +1,38 @@
/*
* Copyright (c) 2019, TheStonedTurtle <https://github.com/TheStonedTurtle>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.ui.overlay.components.table;
import java.awt.Color;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
public class TableElement
{
TableAlignment alignment;
Color color;
String content;
}

View File

@@ -0,0 +1,38 @@
/*
* Copyright (c) 2019, TheStonedTurtle <https://github.com/TheStonedTurtle>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.ui.overlay.components.table;
import java.awt.Color;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
public class TableRow
{
Color rowColor;
TableAlignment rowAlignment;
TableElement[] elements;
}