controller.PaintBuilder

Class RowBuilder

java.lang.Object

controller.PaintBuilder.RowBuilder

public class RowBuilder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
int	bgColor
int	borderColor
int	borderXOffset
int[]	colors
int	currentProgress
int	fgColor
int	fontSize
int[]	ids
int	itemId
int	maximumProgress
int	progressBarHeight
int	progressBarWidth
int	rowHeight
int[]	scales
boolean	showGoal
boolean	showPercentage
int	spriteScale
int	spriteSpacing
int	stringColor
java.lang.String[]	strings
int	stringXOffset
int[]	stringXOffsets
int	stringYOffset
java.lang.String	text
java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
RowBuilder()

Method Summary

Modifier and Type	Method and Description
RowBuilder	centeredSingleStringRow(java.lang.String text, int color, int fontSize) Builds a row with a single centered colored string
RowBuilder	multiItemSpriteRow(int[] ids, int[] scales, java.lang.String[] strings, int[] colors, int borderXOffset, int spriteSpacing, int stringXOffset, int stringYOffset) Builds a row of item sprites and strings.
RowBuilder	multipleStringRow(java.lang.String[] strings, int[] colors, int[] xOffsets, int fontSize) Builds a row with multiple colored strings
RowBuilder	progressBarRow(int current, int maximum, int bgColor, int fgColor, int borderColor, int borderXOffset, int barWidth, int barHeight, boolean showPercentage, boolean showGoal, java.lang.String string, int stringColor) Builds a row with a progress bar and a colored string.
RowBuilder	singleSpriteMultipleStringRow(int itemId, int scale, int borderXOffset, java.lang.String[] strings, int[] colors, int[] stringXOffsets, int stringYOffset) Builds a row with a single item sprite and multiple strings.
RowBuilder	singleSpriteSingleStringRow(int itemId, java.lang.String itemString, int stringColor, int borderXOffset, int spriteScale, int stringXOffset, int stringYOffset) Builds a row with a single item sprite and string.
RowBuilder	singleStringRow(java.lang.String text, int color, int xOffset, int fontSize) Builds a row with a single colored string

Methods inherited from class java.lang.Object

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

Field Detail

ids

public int[] ids

colors

public int[] colors

scales

public int[] scales

stringXOffsets

public int[] stringXOffsets

strings

public java.lang.String[] strings

type

public java.lang.String type

text

public java.lang.String text

itemId

public int itemId

stringColor

public int stringColor

fgColor

public int fgColor

bgColor

public int bgColor

borderColor

public int borderColor

borderXOffset

public int borderXOffset

rowHeight

public int rowHeight

spriteScale

public int spriteScale

spriteSpacing

public int spriteSpacing

stringXOffset

public int stringXOffset

stringYOffset

public int stringYOffset

fontSize

public int fontSize

progressBarWidth

public int progressBarWidth

progressBarHeight

public int progressBarHeight

currentProgress

public int currentProgress

maximumProgress

public int maximumProgress

showGoal

public boolean showGoal

showPercentage

public boolean showPercentage

Constructor Detail

RowBuilder

public RowBuilder()

Method Detail

singleStringRow

public RowBuilder singleStringRow(java.lang.String text,
                                  int color,
                                  int xOffset,
                                  int fontSize)

Builds a row with a single colored string

Parameters:

text - String -- String to paint

color - color -- Color of the string. RGB "HTML" Color Example: 0x36E2D7

xOffset - int -- Amount to offset the string's X from the paint's border

fontSize - int -- Font Size

Returns:

RowBuilder Row

centeredSingleStringRow

public RowBuilder centeredSingleStringRow(java.lang.String text,
                                          int color,
                                          int fontSize)

Builds a row with a single centered colored string

Parameters:

text - String -- String to paint

color - color -- Color of the string. RGB "HTML" Color Example: 0x36E2D7

fontSize - int -- Font Size

Returns:

RowBuilder Row

multipleStringRow

public RowBuilder multipleStringRow(java.lang.String[] strings,
                                    int[] colors,
                                    int[] xOffsets,
                                    int fontSize)

Builds a row with multiple colored strings

Parameters:

strings - int[] -- Strings to draw

colors - int[] -- Colors of the strings. RGB "HTML" Color Example: 0x36E2D7

xOffsets - int[] -- Array of offsets for each string's X from the previous string's X. The first index is the amount offset from paint's border.

fontSize - int -- Font Size

Returns:

RowBuilder Row

multiItemSpriteRow

public RowBuilder multiItemSpriteRow(int[] ids,
                                     int[] scales,
                                     java.lang.String[] strings,
                                     int[] colors,
                                     int borderXOffset,
                                     int spriteSpacing,
                                     int stringXOffset,
                                     int stringYOffset)

Builds a row of item sprites and strings.

Parameters:

ids - int[] -- Array of item ids to paint

scales - int[] -- Array of int to scale each sprite to. 100 is normal, lower is smaller, higher is bigger.

strings - String[] -- Array of strings to paint for each item sprite

colors - int[] -- Array of colors for each string. If given an empty array, it will default to white. RGB "HTML" Color Example: 0x36E2D7

borderXOffset - int -- Amount to offset the row's X from the paint's border

spriteSpacing - int -- Spacing between each sprite

stringXOffset - int -- X offset for the strings relative to the sprite's X. Negative is left while positive is right.

stringYOffset - int -- Y offset for the strings relative to the sprite's Y. Negative is up while positive is down.

Returns:

RowBuilder Row

singleSpriteSingleStringRow

public RowBuilder singleSpriteSingleStringRow(int itemId,
                                              java.lang.String itemString,
                                              int stringColor,
                                              int borderXOffset,
                                              int spriteScale,
                                              int stringXOffset,
                                              int stringYOffset)

Builds a row with a single item sprite and string.

Parameters:

itemId - int -- Item id to draw the sprite for

itemString - String -- String to draw

stringColor - int -- Color of the string. RGB "HTML" Color Example: 0x36E2D7

borderXOffset - int -- Amount to offset the sprite's X from the paint's border

spriteScale - int -- Scale of the items sprite. 100 is normal, lesser is smaller, greater is larger.

stringXOffset - int -- X offset for the string relative to the sprite's X. Negative is left while positive is right.

stringYOffset - int -- Y offset for the string relative to the sprite's Y. Negative is up while positive is down.

Returns:

RowBuilder Row

progressBarRow

public RowBuilder progressBarRow(int current,
                                 int maximum,
                                 int bgColor,
                                 int fgColor,
                                 int borderColor,
                                 int borderXOffset,
                                 int barWidth,
                                 int barHeight,
                                 boolean showPercentage,
                                 boolean showGoal,
                                 java.lang.String string,
                                 int stringColor)

Builds a row with a progress bar and a colored string.

Parameters:

current - int -- Current value to calculate the progress bar from

maximum - int -- Maximum value to calculate the progress bar from

bgColor - int -- Color of the progress bar's background. RGB "HTML" Color Example: 0x36E2D7

fgColor - int -- Color of the progress bar's foreground. RGB "HTML" Color Example: 0x36E2D7

borderColor - int -- Color of the progress bar's border. RGB "HTML" Color Example: 0x36E2D7

borderXOffset - int -- Amount to offset the progress bar's X from the paint's border

barWidth - int -- Width of the progress bar

barHeight - int -- Height of the progress bar

showPercentage - boolean -- Show the percentage on the bar

showGoal - boolean -- Show the start an goal on the bar

string - String -- Description of the progress bar

stringColor - int-- Color of the text. RGB "HTML" Color Example: 0x36E2D7

Returns:

singleSpriteMultipleStringRow

public RowBuilder singleSpriteMultipleStringRow(int itemId,
                                                int scale,
                                                int borderXOffset,
                                                java.lang.String[] strings,
                                                int[] colors,
                                                int[] stringXOffsets,
                                                int stringYOffset)

Builds a row with a single item sprite and multiple strings.

Parameters:

itemId - int -- Id of item sprite to draw

scale - int -- Scale of the items sprite. 100 is normal, lesser is smaller, greater is larger.

borderXOffset - int -- Amount to offset the sprite's X from the paint's border

strings - String[] -- Array of strings

colors - int[] -- Array of colors for the strings

stringXOffsets - int[] -- Array of offsets for each string's X from the previous string's X. The first index is the amount offset from the sprite's X.

stringYOffset - int -- Amount up or down the strings are in the row. Negative is up while positive is down.

Returns: