jfxtras.labs.scene.control.gauge

Class MatrixPanelBuilder<B extends MatrixPanelBuilder<B>>

java.lang.Object

jfxtras.labs.scene.control.gauge.MatrixPanelBuilder<B>

public class MatrixPanelBuilder<B extends MatrixPanelBuilder<B>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MatrixPanelBuilder()

Method Summary

Modifier and Type	Method and Description
MatrixPanel	build()
MatrixPanelBuilder	contents(Content[] CONTENT_ARRAY) Set the Array of Contents
MatrixPanelBuilder	contents(java.util.List<Content> CONTENTS) Set the List of Contents
static MatrixPanelBuilder	create()
MatrixPanelBuilder	frameBaseColor(javafx.scene.paint.Color FRAME_BASE_COLOR) Set the frame base color
MatrixPanelBuilder	frameCustomPath(java.lang.String FRAME_CUSTOM_PATH) Set the path to an image for a custom frame
MatrixPanelBuilder	frameDesign(MatrixPanel.FrameDesign FRAME_DESIGN) Set the frame design
MatrixPanelBuilder	frameVisible(boolean FRAME_VISIBLE) Set if the frame is visible
MatrixPanelBuilder	ledHeight(int LED_HEIGHT) Set the number of LEDs rows
MatrixPanelBuilder	ledWidth(int LED_WIDTH) Set the number of LEDs columns
B	prefHeight(double PREF_HEIGHT) Set the preferred height of the control
B	prefWidth(double PREF_WIDTH) Set the preferred width of the control

Methods inherited from class java.lang.Object

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

Constructor Detail

MatrixPanelBuilder

public MatrixPanelBuilder()

Method Detail

create

public static final MatrixPanelBuilder create()

ledWidth

public final MatrixPanelBuilder ledWidth(int LED_WIDTH)

Set the number of LEDs columns

Parameters:

LED_WIDTH - Insert the columns of LEDs in the maxtrixPanel

Returns:

See Also:

ledHeight(int)

ledHeight

public final MatrixPanelBuilder ledHeight(int LED_HEIGHT)

Set the number of LEDs rows

Parameters:

LED_HEIGHT - Insert the rows of LEDs in the matrixPanel

Returns:

See Also:

ledWidth(int)

contents

public final MatrixPanelBuilder contents(java.util.List<Content> CONTENTS)

Set the List of Contents

Parameters:

CONTENTS - Insert a List of Contents to display in the matrixPanel. Each content can be defined with a ContentBuilder

Returns:

See Also:

ContentBuilder.create()

contents

public final MatrixPanelBuilder contents(Content[] CONTENT_ARRAY)

Set the Array of Contents

Parameters:

CONTENT_ARRAY - Insert an Array of Contents to display in the matrixPanel. Each content can be defined with a ContentBuilder

Returns:

See Also:

ContentBuilder.create()

frameDesign

public final MatrixPanelBuilder frameDesign(MatrixPanel.FrameDesign FRAME_DESIGN)

Set the frame design

Parameters:

FRAME_DESIGN - Select between BLACK_METAL, SHINY_METAL (set a frameBaseColor), CHROME, DARK_GLOSSY, GLOSSY_METAL, or CUSTOM_DESIGN (set a frameCustomPath), in case its visible

Returns:

See Also:

frameVisible(boolean), frameBaseColor(Color), frameCustomPath(String)

frameBaseColor

public final MatrixPanelBuilder frameBaseColor(javafx.scene.paint.Color FRAME_BASE_COLOR)

Set the frame base color

Parameters:

FRAME_BASE_COLOR - frame base color for SHINY_METAL frame design

Returns:

See Also:

frameDesign(MatrixPanel.FrameDesign)

frameCustomPath

public final MatrixPanelBuilder frameCustomPath(java.lang.String FRAME_CUSTOM_PATH)

Set the path to an image for a custom frame

Parameters:

FRAME_CUSTOM_PATH - path to the image for the frame for CUSTOM_DESIGN frame design Options for a valid name of an image, with its extension: <ul><li>It should be already in the source (relative to matrixPanel package)</li> <li>It should be in any of the project’s jars, so /package/path/to/file must be provided</li> <li>A valid URL</li> <li>A full valid path should be added to the name in case it has be loaded from an external resource</li></ul>

Returns:

See Also:

#frameDesign(FrameDesign FrameDesign)

frameVisible

public final MatrixPanelBuilder frameVisible(boolean FRAME_VISIBLE)

Set if the frame is visible

Parameters:

FRAME_VISIBLE - true to show the frame (select a design) or false, to hide the frame

Returns:

See Also:

#frameDesign(FrameDesign)

prefWidth

public final B prefWidth(double PREF_WIDTH)

Set the preferred width of the control

Parameters:

PREF_WIDTH - related to scene dimensions, to keep an aspectRatio of the matrixPanel control equals as the one given by the ratio ledHeight/ledWidth, only prefWidth or prefHeight will be taken into acount and the other value will be adjusted properly.

Returns:

prefHeight

public final B prefHeight(double PREF_HEIGHT)

Set the preferred height of the control

Parameters:

PREF_HEIGHT - related to scene dimensions, to keep an aspectRatio of the matrixPanel control equals as the one given by the ratio ledHeight/ledWidth, only prefWidth or prefHeight will be taken into acount and the other value will be adjusted properly.

Returns:

build

public final MatrixPanel build()