Class JThumbnailStyle

java.lang.Object

org.jorigin.jfx.thumbnail.JThumbnailStyle

public class JThumbnailStyle
extends Object

A set of parameters that enable to control JThumbnailPane and JThumbnail display and layout.

Author:

Julien SEINTURIER - Université de Toulon / CNRS LIS umr 7020 - github.com/jorigin/jcommon (contact@jorigin.org)

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailBackground	Get the thumbnail global background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailFocusedBackground	Get a focused thumbnail global background property.
javafx.beans.property.DoubleProperty	thumbnailHeight	Get the thumbnail height property.
javafx.beans.property.DoubleProperty	thumbnailHGap	Get the thumbnail horizontal gap property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailImageBackground	Get the thumbnail image background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailNameBackground	Get the thumbnail name background property.
javafx.beans.property.BooleanProperty	thumbnailNameVisibility	Get the name visibility property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailPaneBackground	Get the thumbnail pane background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedBackground	Get a selected thumbnail global background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedImageBackground	Get the selected thumbnail image background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedNameBackground	Get the thumbnail name background property when it is selected.
javafx.beans.property.DoubleProperty	thumbnailVGap	Get the thumbnail vertical gap property.
javafx.beans.property.DoubleProperty	thumbnailWidth	Get the thumbnail width property.

Constructor Summary

Constructors

Constructor	Description
JThumbnailStyle()	Create a new set of parameters that enable to control JThumbnailPane and JThumbnail display and layout.

Method Summary

Modifier and Type	Method	Description
javafx.scene.layout.Background	getThumbnailBackground()	Get the thumbnail global background.
javafx.scene.layout.Background	getThumbnailFocusedBackground()	Get a focused thumbnail global background.
double	getThumbnailHeight()	Get the desired height for the JThumbnail instances.
double	getThumbnailHGap()	Get the horizontal spacing between thumbnails.
javafx.scene.layout.Background	getThumbnailImageBackground()	Get the thumbnail image background.
javafx.scene.layout.Background	getThumbnailNameBackground()	Get the thumbnail name background.
javafx.scene.layout.Background	getThumbnailPaneBackground()	Get the thumbnail pane background.
javafx.scene.layout.Background	getThumbnailSelectedBackground()	Get a selected thumbnail global background.
javafx.scene.layout.Background	getThumbnailSelectedImageBackground()	Get the selected thumbnail image background.
javafx.scene.layout.Background	getThumbnailSelectedNameBackground()	Get the thumbnail name background when it is selected.
double	getThumbnailVGap()	Get the vertical spacing between thumbnails.
double	getThumbnailWidth()	Get the desired width for the JThumbnail instances.
boolean	isThumbnailNameVisible()	Get if JThumbnail has to display its name.
void	setThumbnailBackground(javafx.scene.layout.Background background)	Set the thumbnail global background.
void	setThumbnailFocusedBackground(javafx.scene.layout.Background background)	Set a focused thumbnail global background.
void	setThumbnailHeight(double value)	Set the desired height for the JThumbnail instances.
void	setThumbnailHGap(double value)	Set the desired horizontal spacing between thumbnails.
void	setThumbnailImageBackground(javafx.scene.layout.Background background)	Set the thumbnail image background.
void	setThumbnailNameBackground(javafx.scene.layout.Background background)	Set the thumbnail name background.
void	setThumbnailNameVisible(boolean show)	Set if a JThumbnail has to display its name.
void	setThumbnailPaneBackground(javafx.scene.layout.Background background)	Set the thumbnail pane background.
void	setThumbnailSelectedBackground(javafx.scene.layout.Background background)	Set a selected thumbnail global background.
void	setThumbnailSelectedImageBackground(javafx.scene.layout.Background background)	Set the selected thumbnail image background.
void	setThumbnailSelectedNameBackground(javafx.scene.layout.Background background)	Set the thumbnail name background when it is selected.
void	setThumbnailVGap(double value)	Set the desired vertical spacing between thumbnails.
void	setThumbnailWidth(double value)	Set the desired width for the JThumbnail instances.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailBackgroundProperty()	Get the thumbnail global background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailFocusedBackgroundProperty()	Get a focused thumbnail global background property.
javafx.beans.property.DoubleProperty	thumbnailHeightProperty()	Get the thumbnail height property.
javafx.beans.property.DoubleProperty	thumbnailHGapProperty()	Get the thumbnail horizontal gap property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailImageBackgroundProperty()	Get the thumbnail image background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailNameBackgroundProperty()	Get the thumbnail name background property.
javafx.beans.property.BooleanProperty	thumbnailNameVisibilityProperty()	Get the name visibility property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailPaneBackgroundProperty()	Get the thumbnail pane background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedBackgroundProperty()	Get a selected thumbnail global background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedImageBackgroundProperty()	Get the selected thumbnail image background property.
javafx.beans.property.ObjectProperty<javafx.scene.layout.Background>	thumbnailSelectedNameBackgroundProperty()	Get the thumbnail name background property when it is selected.
javafx.beans.property.DoubleProperty	thumbnailVGapProperty()	Get the thumbnail vertical gap property.
javafx.beans.property.DoubleProperty	thumbnailWidthProperty()	Get the thumbnail width property.

Methods inherited from class java.lang.Object

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

Property Details

thumbnailWidth

public javafx.beans.property.DoubleProperty thumbnailWidthProperty

Get the thumbnail width property. This property describe the desired width of a JThumbnail.

See Also:

• getThumbnailWidth()
• setThumbnailWidth(double)
• thumbnailWidthProperty()

thumbnailHeight

public javafx.beans.property.DoubleProperty thumbnailHeightProperty

Get the thumbnail height property. This property describe the desired height of a JThumbnail.

See Also:

• getThumbnailHeight()
• setThumbnailHeight(double)
• thumbnailHeightProperty()

thumbnailImageBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailImageBackgroundProperty

Get the thumbnail image background property.

See Also:

• getThumbnailImageBackground()
• setThumbnailImageBackground(Background)
• thumbnailImageBackgroundProperty()

thumbnailNameBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailNameBackgroundProperty

Get the thumbnail name background property.

See Also:

• getThumbnailNameBackground()
• setThumbnailNameBackground(Background)
• thumbnailNameBackgroundProperty()

thumbnailBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailBackgroundProperty

Get the thumbnail global background property.

See Also:

• getThumbnailBackground()
• setThumbnailBackground(Background)
• thumbnailBackgroundProperty()

thumbnailFocusedBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailFocusedBackgroundProperty

Get a focused thumbnail global background property.

See Also:

• getThumbnailFocusedBackground()
• setThumbnailFocusedBackground(Background)
• thumbnailFocusedBackgroundProperty()

thumbnailSelectedImageBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedImageBackgroundProperty

Get the selected thumbnail image background property.

See Also:

• getThumbnailSelectedImageBackground()
• setThumbnailSelectedImageBackground(Background)
• thumbnailSelectedImageBackgroundProperty()

thumbnailSelectedBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedBackgroundProperty

Get a selected thumbnail global background property.

See Also:

• getThumbnailSelectedBackground()
• setThumbnailSelectedBackground(Background)
• thumbnailSelectedBackgroundProperty()

thumbnailHGap

public javafx.beans.property.DoubleProperty thumbnailHGapProperty

Get the thumbnail horizontal gap property. This property describe the desired horizontal spacing between thumbnails.

See Also:

• getThumbnailHGap()
• setThumbnailHGap(double)
• thumbnailHGapProperty()

thumbnailVGap

public javafx.beans.property.DoubleProperty thumbnailVGapProperty

Get the thumbnail vertical gap property. This property describe the desired vertical spacing between thumbnails.

See Also:

• getThumbnailVGap()
• setThumbnailVGap(double)
• thumbnailVGapProperty()

thumbnailPaneBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailPaneBackgroundProperty

Get the thumbnail pane background property.

See Also:

• getThumbnailPaneBackground()
• setThumbnailPaneBackground(Background)
• thumbnailPaneBackgroundProperty()

thumbnailNameVisibility

public javafx.beans.property.BooleanProperty thumbnailNameVisibilityProperty

Get the name visibility property. This property that set if JThumbnail name has to be visible.

See Also:

• thumbnailNameVisibilityProperty()

thumbnailSelectedNameBackground

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedNameBackgroundProperty

Get the thumbnail name background property when it is selected.

See Also:

• getThumbnailSelectedNameBackground()
• setThumbnailSelectedNameBackground(Background)
• thumbnailSelectedNameBackgroundProperty()

Constructor Details

JThumbnailStyle

public JThumbnailStyle()

Create a new set of parameters that enable to control JThumbnailPane and JThumbnail display and layout.

Method Details

thumbnailWidthProperty

public javafx.beans.property.DoubleProperty thumbnailWidthProperty()

Get the thumbnail width property. This property describe the desired width of a JThumbnail.

Returns:

the thumbnail width property

See Also:

• getThumbnailWidth()
• setThumbnailWidth(double)

getThumbnailWidth

public double getThumbnailWidth()

Get the desired width for the JThumbnail instances.

Returns:

the desired width for the JThumbnail instances

See Also:

• setThumbnailWidth(double)
• thumbnailWidthProperty()

setThumbnailWidth

public void setThumbnailWidth(double value)

Set the desired width for the JThumbnail instances.

Parameters:

value - the desired width for the JThumbnail instances

See Also:

• getThumbnailWidth()
• thumbnailWidthProperty()

thumbnailHeightProperty

public javafx.beans.property.DoubleProperty thumbnailHeightProperty()

Get the thumbnail height property. This property describe the desired height of a JThumbnail.

Returns:

the thumbnail height property

See Also:

• getThumbnailHeight()
• setThumbnailHeight(double)

getThumbnailHeight

public double getThumbnailHeight()

Get the desired height for the JThumbnail instances.

Returns:

the desired height for the JThumbnail instances

See Also:

• setThumbnailHeight(double)
• thumbnailHeightProperty()

setThumbnailHeight

public void setThumbnailHeight(double value)

Set the desired height for the JThumbnail instances.

Parameters:

value - the desired height for the JThumbnail instances

See Also:

• getThumbnailWidth()
• thumbnailWidthProperty()

thumbnailImageBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailImageBackgroundProperty()

Get the thumbnail image background property.

Returns:

the thumbnail image background property

See Also:

• getThumbnailImageBackground()
• setThumbnailImageBackground(Background)

getThumbnailImageBackground

public javafx.scene.layout.Background getThumbnailImageBackground()

Get the thumbnail image background.

Returns:

the thumbnail image background

See Also:

• setThumbnailImageBackground(Background)
• thumbnailImageBackgroundProperty()

setThumbnailImageBackground

public void setThumbnailImageBackground(javafx.scene.layout.Background background)

Set the thumbnail image background.

Parameters:

background - the thumbnail image background

See Also:

• getThumbnailImageBackground()
• thumbnailImageBackground

thumbnailNameBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailNameBackgroundProperty()

Get the thumbnail name background property.

Returns:

the thumbnail name background property

See Also:

• getThumbnailNameBackground()
• setThumbnailNameBackground(Background)

getThumbnailNameBackground

public javafx.scene.layout.Background getThumbnailNameBackground()

Get the thumbnail name background.

Returns:

the thumbnail name background

See Also:

• setThumbnailNameBackground(Background)
• thumbnailNameBackgroundProperty()

setThumbnailNameBackground

public void setThumbnailNameBackground(javafx.scene.layout.Background background)

Set the thumbnail name background.

Parameters:

background - the thumbnail name background

See Also:

• getThumbnailNameBackground()
• thumbnailNameBackground

thumbnailBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailBackgroundProperty()

Get the thumbnail global background property.

Returns:

the thumbnail global background property

See Also:

• getThumbnailBackground()
• setThumbnailBackground(Background)

getThumbnailBackground

public javafx.scene.layout.Background getThumbnailBackground()

Get the thumbnail global background.

Returns:

the thumbnail global background

See Also:

• setThumbnailBackground(Background)
• thumbnailBackground

setThumbnailBackground

public void setThumbnailBackground(javafx.scene.layout.Background background)

Set the thumbnail global background.

Parameters:

background - the thumbnail global background

See Also:

• getThumbnailBackground()
• thumbnailBackground

thumbnailFocusedBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailFocusedBackgroundProperty()

Get a focused thumbnail global background property.

Returns:

the focused thumbnail global background property

See Also:

• getThumbnailFocusedBackground()
• setThumbnailFocusedBackground(Background)

getThumbnailFocusedBackground

public javafx.scene.layout.Background getThumbnailFocusedBackground()

Get a focused thumbnail global background.

Returns:

the focused thumbnail global background

See Also:

• setThumbnailFocusedBackground(Background)
• thumbnailFocusedBackground

setThumbnailFocusedBackground

public void setThumbnailFocusedBackground(javafx.scene.layout.Background background)

Set a focused thumbnail global background.

Parameters:

background - the focused thumbnail global background

See Also:

• getThumbnailFocusedBackground()
• thumbnailFocusedBackground

thumbnailSelectedImageBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedImageBackgroundProperty()

Get the selected thumbnail image background property.

Returns:

the selected thumbnail image background property

See Also:

• getThumbnailSelectedImageBackground()
• setThumbnailSelectedImageBackground(Background)

getThumbnailSelectedImageBackground

public javafx.scene.layout.Background getThumbnailSelectedImageBackground()

Get the selected thumbnail image background.

Returns:

the selected thumbnail image background

See Also:

• setThumbnailSelectedImageBackground(Background)
• thumbnailSelectedImageBackgroundProperty()

setThumbnailSelectedImageBackground

public void setThumbnailSelectedImageBackground(javafx.scene.layout.Background background)

Set the selected thumbnail image background.

Parameters:

background - the selected thumbnail image background

See Also:

• getThumbnailSelectedImageBackground()
• thumbnailSelectedImageBackground

thumbnailSelectedBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedBackgroundProperty()

Get a selected thumbnail global background property.

Returns:

the selected thumbnail global background property

See Also:

• getThumbnailSelectedBackground()
• setThumbnailSelectedBackground(Background)

getThumbnailSelectedBackground

public javafx.scene.layout.Background getThumbnailSelectedBackground()

Get a selected thumbnail global background.

Returns:

the selected thumbnail global background

See Also:

• setThumbnailSelectedBackground(Background)
• thumbnailSelectedBackground

setThumbnailSelectedBackground

public void setThumbnailSelectedBackground(javafx.scene.layout.Background background)

Set a selected thumbnail global background.

Parameters:

background - the selected thumbnail global background

See Also:

• getThumbnailSelectedBackground()
• thumbnailSelectedBackground

thumbnailHGapProperty

public javafx.beans.property.DoubleProperty thumbnailHGapProperty()

Get the thumbnail horizontal gap property. This property describe the desired horizontal spacing between thumbnails.

Returns:

the thumbnail horizontal gap property

See Also:

• getThumbnailHGap()
• setThumbnailHGap(double)

getThumbnailHGap

public double getThumbnailHGap()

Get the horizontal spacing between thumbnails.

Returns:

the horizontal spacing between thumbnails.

See Also:

• setThumbnailHGap(double)
• thumbnailHGapProperty()

setThumbnailHGap

public void setThumbnailHGap(double value)

Set the desired horizontal spacing between thumbnails.

Parameters:

value - the desired horizontal spacing between thumbnails.

See Also:

• getThumbnailHGap()
• thumbnailHGap

thumbnailVGapProperty

public javafx.beans.property.DoubleProperty thumbnailVGapProperty()

Get the thumbnail vertical gap property. This property describe the desired vertical spacing between thumbnails.

Returns:

the thumbnail vertical gap property

See Also:

• getThumbnailVGap()
• setThumbnailVGap(double)

getThumbnailVGap

public double getThumbnailVGap()

Get the vertical spacing between thumbnails.

Returns:

the vertical spacing between thumbnails.

See Also:

• setThumbnailVGap(double)
• thumbnailVGap

setThumbnailVGap

public void setThumbnailVGap(double value)

Set the desired vertical spacing between thumbnails.

Parameters:

value - the desired vertical spacing between thumbnails.

See Also:

• getThumbnailVGap()
• thumbnailVGap

thumbnailPaneBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailPaneBackgroundProperty()

Get the thumbnail pane background property.

Returns:

the thumbnail pane background property

See Also:

• getThumbnailPaneBackground()
• setThumbnailPaneBackground(Background)

getThumbnailPaneBackground

public javafx.scene.layout.Background getThumbnailPaneBackground()

Get the thumbnail pane background.

Returns:

the thumbnail pane background

See Also:

• setThumbnailPaneBackground(Background)
• thumbnailPaneBackground

setThumbnailPaneBackground

public void setThumbnailPaneBackground(javafx.scene.layout.Background background)

Set the thumbnail pane background.

Parameters:

background - the thumbnail pane background

See Also:

• getThumbnailPaneBackground()
• thumbnailPaneBackground

thumbnailNameVisibilityProperty

public javafx.beans.property.BooleanProperty thumbnailNameVisibilityProperty()

Get the name visibility property. This property that set if JThumbnail name has to be visible.

Returns:

the show name property

isThumbnailNameVisible

public boolean isThumbnailNameVisible()

Get if JThumbnail has to display its name.

Returns:

true if a JThumbnail has to display its name and false otherwise

See Also:

• thumbnailNameVisibilityProperty()
• setThumbnailNameVisible(boolean)

setThumbnailNameVisible

public void setThumbnailNameVisible(boolean show)

Set if a JThumbnail has to display its name.

Parameters:

show - true if a JThumbnail has to display its name and false otherwise

See Also:

• thumbnailNameVisibilityProperty()
• isThumbnailNameVisible()

thumbnailSelectedNameBackgroundProperty

public javafx.beans.property.ObjectProperty<javafx.scene.layout.Background> thumbnailSelectedNameBackgroundProperty()

Get the thumbnail name background property when it is selected.

Returns:

the thumbnail name background property when it is selected

See Also:

• getThumbnailSelectedNameBackground()
• setThumbnailSelectedNameBackground(Background)

getThumbnailSelectedNameBackground

public javafx.scene.layout.Background getThumbnailSelectedNameBackground()

Get the thumbnail name background when it is selected.

Returns:

the thumbnail name background when it is selected

See Also:

• setThumbnailSelectedNameBackground(Background)
• thumbnailSelectedNameBackgroundProperty()

setThumbnailSelectedNameBackground

public void setThumbnailSelectedNameBackground(javafx.scene.layout.Background background)

Set the thumbnail name background when it is selected.

Parameters:

background - the thumbnail name background when it is selected

See Also:

• getThumbnailSelectedNameBackground()
• thumbnailSelectedNameBackground