Module org.jcommon

Package org.jorigin.swing.thumbnail

Class JThumbnail<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jorigin.swing.thumbnail.JThumbnail<T>

Type Parameters:

T - the type of the object displayed within the thumbnail.

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

JThumbnailImage

public class JThumbnail<T>
extends JPanel
implements EventListener, MouseListener

A SWING component that is dedicated to the display of a thumbnail.

Since:

1.0.8

Version:

"1.0.14" - b202111241200L

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected T	content	The thumbnail underlying content.
protected Color	currentBgColor	The thumbnail current background color
protected Border	currentBorder	The thumbnail current border
protected Color	focusBgColor	The thumbnail focused background color
protected boolean	focused	Is the label is in focused state.
protected Border	focusedBorder	The thumbnail focused border
protected Color	idColor	The thumbnail identifier font color
protected Font	idFont	The thumbnail identifier font
protected EventListenerList	idListenerList	Liste des ecouteurs informes des evenements du label
protected boolean	idVisible	Is the numerical identifier of the thumbnail has to be visible. By default this value is set to true.
protected boolean	marked	Is the label is in marked state.
protected Color	markedBgColor	The thumbnail marked background color
protected String	name	The thumbnail name.
protected JLabel	nameLB	The thumbnail name label
protected String	nameOrientation	Where the name of the label has to be visible.
protected boolean	nameVisible	Is the name of the thumbnail have to be visible. By default this value is set to true.
protected boolean	selected	Is the label is in selected state.
protected Color	selectedBgColor	The thumbnail activated background color
protected boolean	standard	Is the label is in standard state.
protected Color	standardBgColor	The thumbnail standard background color
protected JComponent	thumbnailComponent	The thumbnail displayed component.
protected int	thumbnailID	The thumbnail numerical identifier.
protected int	thumbnailMargin	The thumbnail margin
protected JPanel	thumbnailPN	The panel dedicated to thumbnail content display.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
JThumbnail(String name, int width, int height, int margin, int ID)	Create a new thumbnail.
JThumbnail(String name, T content, JComponent component, int width, int height, int margin, int labelID)	Create a new thumbnail that display the given component.

Method Summary

Modifier and Type	Method	Description
void	addThumbnailListener(JThumbnailListener<T> l)	Add an Active Label Listener to this Active Label
protected void	fireThumbnailActivated(JThumbnail<T> thumbnail)	Fire a thumbnail activated event.
protected void	fireThumbnailFocused(JThumbnail<T> thumbnail)	Fire a thumbnail focused event.
protected void	fireThumbnailSelected()	Fire a thumbnail selected event.
protected void	fireThumbnailSelected(JThumbnail<T> thumbnail)	Fire a thumbnail selected event.
protected void	fireThumbnailUnfocused(JThumbnail<T> thumbnail)	Fire a thumbnail unfocused event.
T	getContent()	Get the content that is displayed within this thumbnail.
int	getID()	Get the identifier of the thumbnail.
String	getName()
String	getNameOrientation()	Get the orientation of the thumbnail name.
boolean	isFocused()	Set if the thumbnail is focused.
boolean	isIdVisible()	Get if the thumbnail numerical identifier is visible.
boolean	isMarked()	Get if the thumbnail is marked.
boolean	isNameVisible()	Get if the thumbnail name is visible.
boolean	isSelected()	Get if the thumbnail is selected.
boolean	isStandard()	Get if the thumbnail is standard.
protected void	labelActivated()	Fire a label activated event.
void	mouseClicked(MouseEvent e)	mouseClicked
void	mouseEntered(MouseEvent e)	mouseEntered
void	mouseExited(MouseEvent e)	mouseExited
void	mousePressed(MouseEvent e)	mousePressed
void	mouseReleased(MouseEvent e)	mouseReleased
void	paint(Graphics g)
protected void	processComponentMouseEvent(MouseEvent e)	Processin embed component mouse event.
protected void	processLabelMouseEvent(MouseEvent e)	Process a mouse event that occurred on the label.
void	refresh()	Refresh the graphical components of the thumbnail.
protected void	refreshGUI()	Refresh the Graphical User Interface (GUI) components.
void	removeThumbnailListener(JThumbnailListener<T> l)	Remove an Active Label Listener from this Active Label
void	setContent(T content)	Set the content that is displayed within this thumbnail.
void	setFocused(boolean b)	Get if the thumbnail is focused.
void	setIdFont(Font f)	Set the font to use for the thumbnail identifier display.
void	setIdVisible(boolean visible)	Set if the thumbnail numerical identifier has to be visible.
void	setMarked(boolean b)	Set if the thumbnail is marked.
void	setName(String n)
void	setNameOrientation(String nameOrientation)	Set the orientation of the thumbnail name.
void	setNameVisible(boolean nameVisible)	Set if the thumbnail name has to be visible.
void	setSelected(boolean b)	Set if the thumbnail is selected.
void	setStandard(boolean b)	Set if the thumbnail is standard.
void	validate()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

thumbnailPN

protected JPanel thumbnailPN

The panel dedicated to thumbnail content display.

nameLB

protected JLabel nameLB

The thumbnail name label

thumbnailMargin

protected int thumbnailMargin

The thumbnail margin

idFont

protected Font idFont

The thumbnail identifier font

idColor

protected Color idColor

The thumbnail identifier font color

standardBgColor

protected Color standardBgColor

The thumbnail standard background color

focusBgColor

protected Color focusBgColor

The thumbnail focused background color

selectedBgColor

protected Color selectedBgColor

The thumbnail activated background color

markedBgColor

protected Color markedBgColor

The thumbnail marked background color

focusedBorder

protected Border focusedBorder

The thumbnail focused border

currentBorder

protected Border currentBorder

The thumbnail current border

currentBgColor

protected Color currentBgColor

The thumbnail current background color

standard

protected boolean standard

Is the label is in standard state.

focused

protected boolean focused

Is the label is in focused state.

selected

protected boolean selected

Is the label is in selected state.

marked

protected boolean marked

Is the label is in marked state.

thumbnailID

protected int thumbnailID

The thumbnail numerical identifier.

name

protected String name

The thumbnail name.

content

protected T content

The thumbnail underlying content.

thumbnailComponent

protected JComponent thumbnailComponent

The thumbnail displayed component.

idListenerList

protected EventListenerList idListenerList

Liste des ecouteurs informes des evenements du label

nameVisible

protected boolean nameVisible

Is the name of the thumbnail have to be visible.
By default this value is set to true.

nameOrientation

protected String nameOrientation

Where the name of the label has to be visible. Possible values can be:

• BorderLayout.NORTH
• BorderLayout.SOUTH
• BorderLayout.EAST
• BorderLayout.WEST

by default this value is set to BorderLayout.SOUTH.

idVisible

protected boolean idVisible

Is the numerical identifier of the thumbnail has to be visible.
By default this value is set to true.

Constructor Detail

JThumbnail

public JThumbnail(String name,
                  int width,
                  int height,
                  int margin,
                  int ID)

Create a new thumbnail.

Parameters:

name - the name of the thumbnail.

width - the width of the thumbnail.

height - the height of the thumbnail.

margin - the margin size of the thumbnail.

ID - the identifier of the thumbnail.

JThumbnail

public JThumbnail(String name,
                  T content,
                  JComponent component,
                  int width,
                  int height,
                  int margin,
                  int labelID)

Create a new thumbnail that display the given component.

Parameters:

name - the name of the thumbnail.

content - the content of the thumbnail.

component - the component to use as display.

width - the width of the thumbnail.

height - the height of the thumbnail.

margin - the margin size of the thumbnail.

labelID - the identifier of the thumbnail.

Method Detail

setStandard

public void setStandard(boolean b)

Set if the thumbnail is standard.

Parameters:

b - true if the thumbnail is standard and false otherwise.

See Also:

isStandard()

isStandard

public boolean isStandard()

Get if the thumbnail is standard.

Returns:

true if the thumbnail is standard and false otherwise.

See Also:

setStandard(boolean)

setMarked

public void setMarked(boolean b)

Set if the thumbnail is marked.

Parameters:

b - true if the thumbnail is marked and false otherwise.

See Also:

isMarked()

isMarked

public boolean isMarked()

Get if the thumbnail is marked.

Returns:

true if the thumbnail is marked and false otherwise.

See Also:

setMarked(boolean)

setFocused

public void setFocused(boolean b)

Get if the thumbnail is focused.

Parameters:

b - true if the thumbnail is focused and false otherwise.

See Also:

isFocused()

isFocused

public boolean isFocused()

Set if the thumbnail is focused.

Returns:

true if the thumbnail is focused and false otherwise.

See Also:

setFocused(boolean)

setName

public void setName(String n)

Overrides:

setName in class Component

getName

public String getName()

Overrides:

getName in class Component

setContent

public void setContent(T content)

Set the content that is displayed within this thumbnail.

Parameters:

content - the content that is displayed within this thumbnail.

See Also:

getContent()

getContent

public T getContent()

Get the content that is displayed within this thumbnail.

Returns:

the content that is displayed within this thumbnail.

See Also:

setContent(Object)

getID

public int getID()

Get the identifier of the thumbnail.

Returns:

the identifier of the thumbnail.

setSelected

public void setSelected(boolean b)

Set if the thumbnail is selected.

Parameters:

b - true if the thumbnail is selected and false otherwise.

See Also:

isSelected()

isSelected

public boolean isSelected()

Get if the thumbnail is selected.

Returns:

true if the thumbnail is selected and false otherwise.

See Also:

setSelected(boolean)

setIdFont

public void setIdFont(Font f)

Set the font to use for the thumbnail identifier display.

Parameters:

f - the font to use for the thumbnail identifier display.

isNameVisible

public boolean isNameVisible()

Get if the thumbnail name is visible.

Returns:

true if the thumbnail name is visible and false otherwise.

See Also:

setNameVisible(boolean), getNameOrientation()

setNameVisible

public void setNameVisible(boolean nameVisible)

Set if the thumbnail name has to be visible.

Parameters:

nameVisible - true if the thumbnail name has to be visible and false otherwise.

See Also:

isNameVisible(), setNameOrientation(String)

getNameOrientation

public String getNameOrientation()

Get the orientation of the thumbnail name. Possible values can be:

• BorderLayout.NORTH
• BorderLayout.SOUTH
• BorderLayout.EAST
• BorderLayout.WEST

by default this value is set to BorderLayout.SOUTH.

Returns:

the orientation of the thumbnail name.

See Also:

setNameOrientation(String), isNameVisible()

setNameOrientation

public void setNameOrientation(String nameOrientation)

Set the orientation of the thumbnail name. Possible values can be:

• BorderLayout.NORTH
• BorderLayout.SOUTH
• BorderLayout.EAST
• BorderLayout.WEST

by default this value is set to BorderLayout.SOUTH.

Parameters:

nameOrientation - the orientation of the thumbnail name.

See Also:

getNameOrientation(), setNameVisible(boolean)

isIdVisible

public boolean isIdVisible()

Get if the thumbnail numerical identifier is visible.

Returns:

true if the thumbnail numerical identifier is visible and false otherwise.

See Also:

setIdVisible(boolean)

setIdVisible

public void setIdVisible(boolean visible)

Set if the thumbnail numerical identifier has to be visible.

Parameters:

visible - true if the thumbnail numerical identifier has to be visible and false otherwise.

See Also:

isIdVisible()

refresh

public void refresh()

Refresh the graphical components of the thumbnail.

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

fireThumbnailFocused

protected void fireThumbnailFocused(JThumbnail<T> thumbnail)

Fire a thumbnail focused event.

Parameters:

thumbnail - the thumbnail that has raised the event.

fireThumbnailUnfocused

protected void fireThumbnailUnfocused(JThumbnail<T> thumbnail)

Fire a thumbnail unfocused event.

Parameters:

thumbnail - the thumbnail that has raised the event.

fireThumbnailSelected

protected void fireThumbnailSelected()

Fire a thumbnail selected event.

fireThumbnailSelected

protected void fireThumbnailSelected(JThumbnail<T> thumbnail)

Fire a thumbnail selected event.

Parameters:

thumbnail - the thumbnail that has raised the event.

fireThumbnailActivated

protected void fireThumbnailActivated(JThumbnail<T> thumbnail)

Fire a thumbnail activated event.

Parameters:

thumbnail - the thumbnail that has raised the event.

labelActivated

protected void labelActivated()

Fire a label activated event.

addThumbnailListener

public void addThumbnailListener(JThumbnailListener<T> l)

Add an Active Label Listener to this Active Label

Parameters:

l - ActiveLabelListener Listener added to the Active Label

removeThumbnailListener

public void removeThumbnailListener(JThumbnailListener<T> l)

Remove an Active Label Listener from this Active Label

Parameters:

l - ActiveLabelListener Active Listener to remove

mouseClicked

public void mouseClicked(MouseEvent e)

mouseClicked

Specified by:

mouseClicked in interface MouseListener

Parameters:

e - MouseEvent

mouseEntered

public void mouseEntered(MouseEvent e)

mouseEntered

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - MouseEvent

mouseExited

public void mouseExited(MouseEvent e)

mouseExited

Specified by:

mouseExited in interface MouseListener

Parameters:

e - MouseEvent

mousePressed

public void mousePressed(MouseEvent e)

mousePressed

Specified by:

mousePressed in interface MouseListener

Parameters:

e - MouseEvent

mouseReleased

public void mouseReleased(MouseEvent e)

mouseReleased

Specified by:

mouseReleased in interface MouseListener

Parameters:

e - MouseEvent

processLabelMouseEvent

protected void processLabelMouseEvent(MouseEvent e)

Process a mouse event that occurred on the label.

Parameters:

e - the underlying mouse event

refreshGUI

protected void refreshGUI()

Refresh the Graphical User Interface (GUI) components.

processComponentMouseEvent

protected void processComponentMouseEvent(MouseEvent e)

Processin embed component mouse event.

Parameters:

e - The mouse event fired by embed component

validate

public void validate()

Overrides:

validate in class Container