com.goldencode.p2j.ui.client.gui.filechooser

Class FileThumb

java.lang.Object

com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

com.goldencode.p2j.ui.client.AbstractButton<O,ButtonConfig>

com.goldencode.p2j.ui.client.Button<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.GuiButton

com.goldencode.p2j.ui.client.gui.ButtonGuiImpl

com.goldencode.p2j.ui.client.gui.filechooser.FileThumb

All Implemented Interfaces:

AutoResizable<ButtonConfig>, FocusListener, KeyListener, LabeledWidget<GuiOutputManager>, MnemonicTrait<GuiOutputManager>, ReleasedKeySensible, Widget<GuiOutputManager>, WidgetWithConfig<ButtonConfig>, ConfigOwner<ButtonConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ContentThumbView.ContentIcon, DetailsThumbView.DetailsIcon, ListThumbView.ListItem, MediumIconsThumbView.MediumIcon, SmallIconsThumbView.SmallIcon, TilesThumbView.TileIcon

public abstract class FileThumb
extends ButtonGuiImpl

This is the base class for all file thumbs shown in file chooser dialog. It groups the common properties of the thumbnail of each view mode from file chooser.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.gui.ButtonGuiImpl

ButtonGuiImpl.Images

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.attribute.FileTime	created Cached file/folder creation timestamp.
private boolean	doubleClick Flag for a double-click event.
private java.lang.String	doubleClickCommand The action to be performed when the thumbnail is double clicked.
protected long	fileSize Cached file/folder size.
protected ImageWrapper<java.awt.image.BufferedImage>	img The icon to be displayed.
private boolean	isDir Flags the thumbnails that represents directories.
protected java.nio.file.attribute.FileTime	lastModified Cached last modified timestamp.
private java.nio.file.Path	path The path this thumbnail represents.
private static FileThumb	selected The currently selected thumbnail.

Fields inherited from class com.goldencode.p2j.ui.client.gui.ButtonGuiImpl

cc, DOT_LINE_WIDTH, gd, gf, imgUp

Fields inherited from class com.goldencode.p2j.ui.client.AbstractButton

config, widgetFocused

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

insets, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
FileThumb(WidgetId id, ButtonConfig cfg, java.nio.file.Path path, java.lang.String image, boolean isDir, java.lang.String click2Command) Constructor used to create component using given configuration.

Method Summary

Modifier and Type	Method and Description
static void	clearSelection() Clears the selection flag.
void	draw() Draw the thumbnail.
protected abstract void	drawForeground(int width, int height, Theme theme) Draws the text and icon on this thumbnail.
(package private) java.lang.String	getDoubleClickCommand() Retrieves the action to be performed when the thumbnail is double clicked.
protected abstract NativeDimension	getEditorDimension() Obtain the dimension of the editor that when renaming this thumbnail.
protected abstract NativePoint	getEditorLocation() Obtain the physical location of the editor that when renaming this thumbnail.
ImageWrapper<java.awt.image.BufferedImage>	getFileIcon() Obtain the file icon, if set.
java.nio.file.Path	getPath() Obtain the path this thumbnail represents.
int	getPreferredHeight() Query the preferred height of this thumbnail.
int	getPreferredWidth() Query the preferred width of this thumbnail.
static FileThumb	getSelected() Query the currently selected thumbnail.
(package private) java.lang.String	getTooltip() Obtain the tooltip to be displayed when hovering this thumbnail.
protected void	handleBasicEvents(KeyInput event) Process basic events - key navigation event.
boolean	isDir() Checks whether this thumbnail represents a directory.
(package private) boolean	isDoubleClick() Check whether the mouse was double-clicked on this thumbnail.
boolean	isSelected() Checks if this thumbnail is selected.
void	mouseClicked(java.awt.event.MouseEvent e) Notification of a mouse clicked event occurred for this widget.
static void	select(FileThumb ft) Sets the selected thumb.
(package private) void	setFileInfo(long fileSize, java.nio.file.attribute.FileTime created, java.nio.file.attribute.FileTime lastModified) Sets information of the file that this thumbnail represents.
static void	startRename(LineEditor rename) Enter the rename mode for active thumbnail.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.goldencode.p2j.ui.client.gui.ButtonGuiImpl

afterConfigUpdate, createMnemonic, focusTraversable, getFontResolver, getImgDisabled, getImgDown, getImgUp, handleCursorKeys, height, highlighted, initialize, isAutoResize, isDefaultButton, isDroppable, isFocusable, isKeyPressed, isMnemonicSupported, isPressed, isResolverColorsUsed, loadImage, onFocusLost, physicalBounds, processEvent, processMnemonic, refresh, requestFocus, setActionCode, setColorResolver, setFontResolver, setImage, setImage, setResolverColorsUsed, setVisible, supportsCustomMousePointer, updateSize, width

Methods inherited from class com.goldencode.p2j.ui.client.gui.GuiButton

isMouseOver, mouseActions, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased

Methods inherited from class com.goldencode.p2j.ui.client.Button

addListener, checkKey, config, destroy, getColon, getColumnLabelText, getCommand, getLabelInstance, getLabelText, getMnemonic, getTo, initButtonText, isForceLabel, isNoLabels, isRightAligned, postprocessConfig, processKeyEvent, setCommand, setHidden, setLabelInstance, setMnemonic, setNoLabels, setSupportsMnemonic, setText, setTextLabel, setWasVisible, textLabel, wasVisible

Methods inherited from class com.goldencode.p2j.ui.client.AbstractButton

dimension, forceCursorOnFocus, getDefaultEvent, ignoreAction, manageSystemActions, minimumSize, onFocusGained, onKeyPressed, onKeyTyped, processKeyEventCommon

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, findMouseSource, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, initialHeight, initialWidth, insets, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalDimension, physicalLocation, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectAncestorChange, reflectLocationChanged, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, showPopupMenu, sync, topLevelWindow, translate, triggerLocationChanged, unrealize, unregisterWidgetListener, updateSizeWorker, updateSystemParent, widgetRealized, widgetStateChanged, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalDimension, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyListeners, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, window

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Methods inherited from interface com.goldencode.p2j.ui.client.MnemonicTrait

getColumnMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, setColumnMnemonic, updateMnemonic

Field Detail

img

protected final ImageWrapper<java.awt.image.BufferedImage> img

The icon to be displayed.

fileSize

protected long fileSize

Cached file/folder size.

created

protected java.nio.file.attribute.FileTime created

Cached file/folder creation timestamp.

lastModified

protected java.nio.file.attribute.FileTime lastModified

Cached last modified timestamp.

doubleClickCommand

private final java.lang.String doubleClickCommand

The action to be performed when the thumbnail is double clicked.

doubleClick

private boolean doubleClick

Flag for a double-click event.

isDir

private final boolean isDir

Flags the thumbnails that represents directories.

path

private final java.nio.file.Path path

The path this thumbnail represents.

selected

private static FileThumb selected

The currently selected thumbnail.

Constructor Detail

FileThumb

FileThumb(WidgetId id,
          ButtonConfig cfg,
          java.nio.file.Path path,
          java.lang.String image,
          boolean isDir,
          java.lang.String click2Command)

Constructor used to create component using given configuration.

Parameters:

id - The widget's ID.

cfg - The widget's configuration.

path - The path this thumbnail represents.

image - The image to be displayed on the thumbnail.

isDir - Flags the thumbnails that represents directories.

click2Command - The action to be performed when the thumbnail is double clicked.

Method Detail

getPreferredWidth

public int getPreferredWidth()

Query the preferred width of this thumbnail. It is used by some thumbnail containers in order to do the internal layout. If width is not important, the thumbnail can return -1.

Returns:

the preferred width of this thumbnail.

getPreferredHeight

public int getPreferredHeight()

Query the preferred height of this thumbnail. It is used by some thumbnail containers in order to do the internal layout. If height is not important, the thumbnail can return -1.

Returns:

the preferred width of this thumbnail.

getPath

public java.nio.file.Path getPath()

Obtain the path this thumbnail represents.

Returns:

the path this thumbnail represents.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Notification of a mouse clicked event occurred for this widget. Simulate ENTER key typing. The main reason it is overwritten here is to set doubleClick if double click is detected.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class ButtonGuiImpl

Parameters:

e - The mouse event.

draw

public void draw()

Draw the thumbnail. Called by this Button's parent container. It makes sure the driver is properly configured and clipped, draws the background and then calls drawForeground for drawing the text/icon on the thumbnail.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class ButtonGuiImpl

drawForeground

protected abstract void drawForeground(int width,
                                       int height,
                                       Theme theme)

Draws the text and icon on this thumbnail.

Parameters:

width - The width of the widget

height - The height of the widget.

theme - The current theme.

isSelected

public boolean isSelected()

Checks if this thumbnail is selected.

Returns:

true if this thumbnail is selected.

clearSelection

public static void clearSelection()

Clears the selection flag. No thumbnail will be selected.

getSelected

public static FileThumb getSelected()

Query the currently selected thumbnail.

Returns:

the currently selected thumbnail.

isDir

public boolean isDir()

Checks whether this thumbnail represents a directory.

Returns:

true if this thumbnail represents a directory.

getFileIcon

public ImageWrapper<java.awt.image.BufferedImage> getFileIcon()

Obtain the file icon, if set.

Returns:

the file icon of this thumbnail.

select

public static void select(FileThumb ft)

Sets the selected thumb.

Parameters:

ft - The new FileThumb to select. May be null to unselect.

getDoubleClickCommand

java.lang.String getDoubleClickCommand()

Retrieves the action to be performed when the thumbnail is double clicked.

Note: this resets the doubleClick flag, so a subsequent call will return the simple click command.

Returns:

the action to be performed when the thumbnail is double clicked and otherwise the simple-click command.

isDoubleClick

boolean isDoubleClick()

Check whether the mouse was double-clicked on this thumbnail.

Returns:

true if the mouse was double-clicked.

setFileInfo

void setFileInfo(long fileSize,
                 java.nio.file.attribute.FileTime created,
                 java.nio.file.attribute.FileTime lastModified)

Sets information of the file that this thumbnail represents.

Parameters:

fileSize - The file size.

created - Creation timestamp.

lastModified - The timestamp of last modification of the file.

handleBasicEvents

protected void handleBasicEvents(KeyInput event)

Process basic events - key navigation event.

Overrides:

handleBasicEvents in class ButtonGuiImpl

Parameters:

event - Key event to process.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class ButtonGuiImpl

Returns:

A string representation of the object.

getTooltip

java.lang.String getTooltip()

Obtain the tooltip to be displayed when hovering this thumbnail.

Returns:

the tooltip to be displayed when hovering this thumbnail.

startRename

public static void startRename(LineEditor rename)

Enter the rename mode for active thumbnail.

Parameters:

rename - The line editor that will be used for renaming.

getEditorDimension

protected abstract NativeDimension getEditorDimension()

Obtain the dimension of the editor that when renaming this thumbnail.

Returns:

the dimension of the editor that when renaming this thumbnail.

getEditorLocation

protected abstract NativePoint getEditorLocation()

Obtain the physical location of the editor that when renaming this thumbnail. The location is relative to this widget.

Returns:

the physical location of the editor that when renaming this thumbnail.