jidefx.utils

Class PredefinedShapes

java.lang.Object

jidefx.utils.PredefinedShapes

public class PredefinedShapes
extends java.lang.Object

A collection of pre-defined shapes. All the methods take a size as parameter and returns a Node which is a Shape or a Group. You can set the fill color, stroke color on the shape if you would like to adjust the colors.

We created this class mainly because we need to use some icons inside our products. Ideally it probably should support svg files. Since we are not using a whole lot of icons, we decided to create them using Java code to avoid the dependency on a svg reader.

Constructor Summary

Constructors

Constructor and Description
PredefinedShapes()

Method Summary

Modifier and Type	Method and Description
javafx.scene.shape.Shape	createArrowedIcon(javafx.scene.shape.Shape shape) Creates a shape by adding a down arrow to it.
javafx.scene.shape.Shape	createArrowedIcon(javafx.scene.shape.Shape shape, javafx.geometry.Pos pos, double ratio) Creates a shape by adding a down arrow to it.
javafx.scene.shape.Shape	createArrowIcon(double size) Creates an arrow icon.
javafx.scene.shape.Shape	createCalendarIcon(double size) Creates a calendar icon.
javafx.scene.shape.Shape	createClearIcon(double size) Create a clear node with a circle plus a cross inside within an area
javafx.scene.shape.Shape	createClockIcon(double size) Creates a clock icon.
javafx.scene.Group	createCloseIcon(double size) Create a close node with a circle plus a cross inside within an area.
javafx.scene.shape.Shape	createFilterIcon(double size) Creates a filter icon.
javafx.scene.shape.Shape	createKeyIcon(double size) Creates a key icon.
javafx.scene.shape.Shape	createMagnifierIcon(double size) Creates a magnifier glass icon.
javafx.scene.shape.Shape	createMagnifierIcon(double size, boolean showArrow) Creates a magnifier glass icon with or without a down arrow.
javafx.scene.shape.Shape	createMinusIcon(double size) Creates a minus icon.
javafx.scene.shape.Shape	createPlusIcon(double size) Creates a plus icon.
static PredefinedShapes	getInstance() Gets the default instance of PredefinedShapes.
static void	setInstance(PredefinedShapes instance) Sets your own instance of PredefinedShapes if you want to customize the predefined shapes.

Methods inherited from class java.lang.Object

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

Constructor Detail

PredefinedShapes

public PredefinedShapes()

Method Detail

getInstance

public static PredefinedShapes getInstance()

Gets the default instance of PredefinedShapes.

Returns:

the default instance of PredefinedShapes.

See Also:

setInstance(PredefinedShapes)

setInstance

public static void setInstance(PredefinedShapes instance)

Sets your own instance of PredefinedShapes if you want to customize the predefined shapes.

Parameters:

instance - a new instance.

createArrowIcon

public javafx.scene.shape.Shape createArrowIcon(double size)

Creates an arrow icon.

Parameters:

size - the size of the icon

Returns:

an arrow icon.

createClearIcon

public javafx.scene.shape.Shape createClearIcon(double size)

Create a clear node with a circle plus a cross inside within an area

Parameters:

size - the size of icon

Returns:

a clear icon.

createCloseIcon

public javafx.scene.Group createCloseIcon(double size)

Create a close node with a circle plus a cross inside within an area. It is a group with three nodes in it.

Parameters:

size - the size of icon

Returns:

a close icon.

createMagnifierIcon

public javafx.scene.shape.Shape createMagnifierIcon(double size)

Creates a magnifier glass icon.

Parameters:

size - the size of the icon

Returns:

a magnifier icon.

createMagnifierIcon

public javafx.scene.shape.Shape createMagnifierIcon(double size,
                                                    boolean showArrow)

Creates a magnifier glass icon with or without a down arrow.

Parameters:

size - the size of the icon

showArrow - true to include a down arrow. False to not include one.

Returns:

a magnifier icon.

createFilterIcon

public javafx.scene.shape.Shape createFilterIcon(double size)

Creates a filter icon.

Parameters:

size - the size of the icon

Returns:

a filter icon.

createKeyIcon

public javafx.scene.shape.Shape createKeyIcon(double size)

Creates a key icon.

Parameters:

size - the size of the icon

Returns:

a key icon.

createCalendarIcon

public javafx.scene.shape.Shape createCalendarIcon(double size)

Creates a calendar icon.

Parameters:

size - the size of the icon

Returns:

a calendar icon.

createClockIcon

public javafx.scene.shape.Shape createClockIcon(double size)

Creates a clock icon.

Parameters:

size - the size of the icon

Returns:

a clock icon.

createArrowedIcon

public javafx.scene.shape.Shape createArrowedIcon(javafx.scene.shape.Shape shape)

Creates a shape by adding a down arrow to it. By default, it will be added to the bottom right of the original shape. The width of the arrow is 0.4 of the original shape's width.

Parameters:

shape - the original shape.

Returns:

the shape with a down arrow

createArrowedIcon

public javafx.scene.shape.Shape createArrowedIcon(javafx.scene.shape.Shape shape,
                                                  javafx.geometry.Pos pos,
                                                  double ratio)

Creates a shape by adding a down arrow to it.

Parameters:

shape - the original shape.

pos - the position of the down arrow. For now only BOTTOM_LEFT, BOTTOM_RIGHT, TOP_RIGHT, TOP_LEFT are supported.

ratio - the arrow width to the original shape's width ratio.

Returns:

the shape with a down arrow

createPlusIcon

public javafx.scene.shape.Shape createPlusIcon(double size)

Creates a plus icon.

Parameters:

size - the size of the icon

Returns:

a plus icon.

createMinusIcon

public javafx.scene.shape.Shape createMinusIcon(double size)

Creates a minus icon.

Parameters:

size - the size of the icon

Returns:

a minus icon.