com.luciad.gui

LuciadLightspeedClass TLcdBoxIcon.Builder

java.lang.Object

com.luciad.gui.TLcdBoxIcon.Builder

Enclosing class:

TLcdBoxIcon

public static final class TLcdBoxIcon.Builder
extends Object

Builder for creating a box icon. The default box has a padding of 2 pixels, a white 1-pixel border and no fill.

Since:

2018.1

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TLcdBoxIcon	build() Creates a new box icon.
TLcdBoxIcon.Builder	fillColor(Color aFillColor) Sets the color that fills the background.
TLcdBoxIcon.Builder	filled(boolean aFilled) Sets whether to paint the content on a filled background.
TLcdBoxIcon.Builder	frame(boolean aFramed) Sets whether or not to surround the content with a frame.
TLcdBoxIcon.Builder	frameColor(Color aFrameColor) Sets the color of the frame.
TLcdBoxIcon.Builder	frameLineWidth(int aLineWidth) Sets the width of the border of the frame.
TLcdBoxIcon.Builder	icon(ILcdIcon aIcon) Sets the icon to draw a box around.
TLcdBoxIcon.Builder	padding(int aPadding) Sets the amount of padding around the text, in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

icon

public TLcdBoxIcon.Builder icon(ILcdIcon aIcon)

Sets the icon to draw a box around.

Parameters:

aIcon - the icon to draw a box around. Never null.

frameColor

public TLcdBoxIcon.Builder frameColor(Color aFrameColor)

Sets the color of the frame.

Parameters:

aFrameColor - the new color to paint the frame, or null if no color should be set

See Also:

TLcdBoxIcon.getFrameColor()

fillColor

public TLcdBoxIcon.Builder fillColor(Color aFillColor)

Sets the color that fills the background.

Parameters:

aFillColor - the color to fill the background, if this behavior is enabled

See Also:

TLcdBoxIcon.getFillColor(), filled(boolean)

frame

public TLcdBoxIcon.Builder frame(boolean aFramed)

Sets whether or not to surround the content with a frame.

Parameters:

aFramed - true to paint the content in a frame.

See Also:

TLcdBoxIcon.isFrame()

frameLineWidth

public TLcdBoxIcon.Builder frameLineWidth(int aLineWidth)

Sets the width of the border of the frame.

Parameters:

aLineWidth - the width of the border of the frame, in pixels

filled

public TLcdBoxIcon.Builder filled(boolean aFilled)

Sets whether to paint the content on a filled background.

Parameters:

aFilled - true to paint content on a filled background.

See Also:

TLcdBoxIcon.isFilled(), fillColor(Color)

padding

public TLcdBoxIcon.Builder padding(int aPadding)

Sets the amount of padding around the text, in pixels. If the frame is painted, it will be painted around this margin.

Parameters:

aPadding - the new padding size, in pixels. Must be >= 0.

See Also:

TLcdBoxIcon.getPadding()

build

public TLcdBoxIcon build()

Creates a new box icon. Requires at least the icon(com.luciad.gui.ILcdIcon) content to be set.

Returns:

a new box icon

Throws:

IllegalStateException - If any of the mandatory properties has not been set.