public interface AsciiArtBuilder extends Text<AsciiArtBuilder>, FontAccessor.FontProperty, FontAccessor.FontBuilder<AsciiArtBuilder>, FontTypeAccessor.FontTypeProperty, FontTypeAccessor.FontTypeBuilder<AsciiArtBuilder>, FontStyleAccessor.FontStyleProperty, FontStyleAccessor.FontStyleBuilder<AsciiArtBuilder>, FontSizeAccessor.FontSizeProperty, FontSizeAccessor.FontSizeBuilder<AsciiArtBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<AsciiArtBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty
AsciiArtBuilder
is represented by an array of
String
instances "visualizing" a given text as so called ASCII art -
rendered with the given Font
. ASCII characters are used as "pixels"
when "paining" the text into the String
array. Different ASCII
characters represent different levels of brightness for a "pixel". The
attributes supported by the builder:TextAccessor.TextBuilder<B extends TextAccessor.TextBuilder<B>>, TextAccessor.TextMutator, TextAccessor.TextProperty
FontAccessor.FontBuilder<B extends FontAccessor.FontBuilder<B>>, FontAccessor.FontMutator, FontAccessor.FontProperty
FontTypeAccessor.FontTypeBuilder<B extends FontTypeAccessor.FontTypeBuilder<B>>, FontTypeAccessor.FontTypeMutator, FontTypeAccessor.FontTypeProperty
FontStyleAccessor.FontStyleBuilder<B extends FontStyleAccessor.FontStyleBuilder<B>>, FontStyleAccessor.FontStyleMutator, FontStyleAccessor.FontStyleProperty
FontSizeAccessor.FontSizeBuilder<B extends FontSizeAccessor.FontSizeBuilder<B>>, FontSizeAccessor.FontSizeMutator, FontSizeAccessor.FontSizeProperty
org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty
Modifier and Type | Method and Description |
---|---|
AsciiArtMode |
getAsciiArtMode()
Retrieves the ASCII art mode from the ASCII art mode property.
|
AsciiColorPalette |
getAsciiColorPalette()
Retrieves the ASCII color palette from the ASCII color palette property.
|
char[] |
getAsciiColors()
Retrieves the ASCII colors from the ASCII colors property.
|
PixmapRatioMode |
getPixmapRatioMode()
Retrieves the pixmap ratio mode from the pixmap ratio mode property.
|
org.refcodes.graphical.RgbPixmap |
getRgbPixmap()
Retrieves the pixmap from the pixmap property.
|
void |
setAsciiArtMode(AsciiArtMode aAsciiArtMode)
Sets the ASCII art mode for the ASCII art mode property.
|
void |
setAsciiColorPalette(AsciiColorPalette aAsciiColorPalette)
Sets the ASCII color palette for the ASCII color palette property.
|
void |
setAsciiColors(char... aAsciiColors)
Sets the ASCII colors for the ASCII colors property.
|
void |
setPixmapRatioMode(PixmapRatioMode aPixmapRatioMode)
Sets the pixmap ratio mode for the pixmap ratio mode property.
|
void |
setRgbPixmap(org.refcodes.graphical.RgbPixmap aPixmap)
Sets the pixmap for the pixmap property.
|
String |
toString(org.refcodes.graphical.RgbPixmap aPixmap)
Race condition safe shortcut for using
withRgbPixmap(RgbPixmap)
followed by Text.toString() . |
String[] |
toStrings(org.refcodes.graphical.RgbPixmap aPixmap)
Race condition safe shortcut for using
withRgbPixmap(RgbPixmap)
followed by Text.toStrings() . |
default AsciiArtBuilder |
withAsciiArtMode(AsciiArtMode aAsciiArtMode)
Sets the ASCII art mode for the ASCII art mode property.
|
default AsciiArtBuilder |
withAsciiColorPalette(AsciiColorPalette aAsciiColorPalette)
Sets the ASCII color palette for the ASCII color palette property.
|
default AsciiArtBuilder |
withAsciiColors(char... aAsciiColors)
Sets the ASCII colors for the ASCII colors property.
|
default AsciiArtBuilder |
withPixmapRatioMode(PixmapRatioMode aPixmapRatioMode)
Sets the pixmap ratio mode for the pixmap ratio mode property.
|
default AsciiArtBuilder |
withRgbPixmap(org.refcodes.graphical.RgbPixmap aPixmap)
Sets the pixmap for the pixmap property.
|
toString, toString, toStrings, toStrings, withText
getText
setText, setText
withText
getFont
setFont
withFont
getFontType
setFontType
withFontType
getFontStyle
setFontStyle
withFontStyle
getFontSize
setFontSize
withFontSize
AsciiArtMode getAsciiArtMode()
void setAsciiArtMode(AsciiArtMode aAsciiArtMode)
aAsciiArtMode
- The ASCII art mode to be stored by the text strip
mode property.default AsciiArtBuilder withAsciiArtMode(AsciiArtMode aAsciiArtMode)
aAsciiArtMode
- The ASCII art mode to be stored by the text strip
mode property.PixmapRatioMode getPixmapRatioMode()
void setPixmapRatioMode(PixmapRatioMode aPixmapRatioMode)
aPixmapRatioMode
- The pixmap ratio mode to be stored by the text
strip mode property.default AsciiArtBuilder withPixmapRatioMode(PixmapRatioMode aPixmapRatioMode)
aPixmapRatioMode
- The pixmap ratio mode to be stored by the text
strip mode property.char[] getAsciiColors()
void setAsciiColors(char... aAsciiColors)
aAsciiColors
- The ASCII colors to be stored by the text align mode
property.default AsciiArtBuilder withAsciiColors(char... aAsciiColors)
aAsciiColors
- The ASCII colors to be stored by the text align mode
property.AsciiColorPalette getAsciiColorPalette()
void setAsciiColorPalette(AsciiColorPalette aAsciiColorPalette)
aAsciiColorPalette
- The ASCII color palette to be stored by the
text align mode property.default AsciiArtBuilder withAsciiColorPalette(AsciiColorPalette aAsciiColorPalette)
aAsciiColorPalette
- The ASCII color palette to be stored by the
text align mode property.org.refcodes.graphical.RgbPixmap getRgbPixmap()
void setRgbPixmap(org.refcodes.graphical.RgbPixmap aPixmap)
aPixmap
- The pixmap to be stored by the text align mode property.default AsciiArtBuilder withRgbPixmap(org.refcodes.graphical.RgbPixmap aPixmap)
aPixmap
- The pixmap to be stored by the text align mode property.String toString(org.refcodes.graphical.RgbPixmap aPixmap)
withRgbPixmap(RgbPixmap)
followed by Text.toString()
.
Implementation requirements: This method must not(!) be implemented by
calling withRgbPixmap(RgbPixmap)
followed by Text.toString()
(do not change the pixmap property) as this would not be thread safe!aPixmap
- The pixmap to be stored by the text align mode property.String
arrayString[] toStrings(org.refcodes.graphical.RgbPixmap aPixmap)
withRgbPixmap(RgbPixmap)
followed by Text.toStrings()
.
Implementation requirements: This method must not(!) be implemented by
calling withRgbPixmap(RgbPixmap)
followed by
Text.toStrings()
(do not change the pixmap property) as this would
not be thread safe!aPixmap
- The pixmap to be stored by the text align mode property.String
arrayCopyright © 2016. All rights reserved.