Module org.autogui

Package org.autogui.swing.util

Class SearchTextFieldFilePath

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.SearchTextField

org.autogui.swing.util.SearchTextFieldFilePath

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

GuiSwingViewFilePathField.PropertyFilePathPane

public class SearchTextFieldFilePath
extends SearchTextField

a text-field with background searching file-items

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchTextFieldFilePath.DesktopOpenAction	the action for opening files
static class	SearchTextFieldFilePath.DesktopRevealAction	the action for showing files in Finder or Explorer
static class	SearchTextFieldFilePath.FileClearAction	action for clearing the field
static class	SearchTextFieldFilePath.FileCopyAllAction	copying the selected file
static class	SearchTextFieldFilePath.FileInfoItem	a file info item
static class	SearchTextFieldFilePath.FileItem	a completed file item
static class	SearchTextFieldFilePath.FileItemWithKey
static class	SearchTextFieldFilePath.FileListAction	an abstract definition of a file-list
static class	SearchTextFieldFilePath.FileListEditAction	the action for completing a searched file-item
static class	SearchTextFieldFilePath.FilePasteAction	the action for text paste
static class	SearchTextFieldFilePath.FileSelection	transferable object for a file list
static class	SearchTextFieldFilePath.FileTransferHandler	a transfer-handler for copying and pasting a file-list
static class	SearchTextFieldFilePath.IconWrapper
static class	SearchTextFieldFilePath.OpenDialogAction	an action for selecting a file item from an open dialog
static class	SearchTextFieldFilePath.SearchTextFieldModelFilePath	the model definition for the completing file items

Nested classes/interfaces inherited from class org.autogui.swing.util.SearchTextField

SearchTextField.DynamicItemAction, SearchTextField.SearchBackgroundPainter, SearchTextField.SearchBackgroundPainterBordered, SearchTextField.SearchedItemsListener, SearchTextField.SearchTask, SearchTextField.SearchTextFieldModel, SearchTextField.SearchTextFieldModelEmpty, SearchTextField.SearchTextFieldPublisher, SearchTextField.SearchTextFieldPublisherEmpty

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
static String	MENU_CATEGORY_FILE_CANDIDATE
static String	MENU_CATEGORY_FILE_CHILD
static String	MENU_CATEGORY_FILE_CURRENT
static String	MENU_CATEGORY_FILE_DEFAULT
static String	MENU_CATEGORY_FILE_PARENT
static String	MENU_CATEGORY_FILE_SIBLING

Fields inherited from class org.autogui.swing.util.SearchTextField

backgroundPainter, buttonsPane, currentSearchedItems, currentTask, editingRunner, emptyIcon, field, icon, menuItemsSource, model, popup, popupButton, searchedItemsListeners, undoManager

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
SearchTextFieldFilePath()
SearchTextFieldFilePath(SearchTextFieldFilePath.SearchTextFieldModelFilePath model)

Method Summary

Modifier and Type	Method	Description
static String	formatFileSize(long size)
Path	getFile()
SearchTextFieldFilePath.FileItem	getFileItem(Path file)
List<Object>	getMenuItemsSource()
void	init()
void	initPopup()
void	initTransferHandler()
boolean	isUpdateFieldModifiedEvent(Object e)
void	setFile(Path file)	the method is a simulated GUI task originally caused by the user.
void	setTextFromSearchedItem(PopupCategorized.CategorizedMenuItem item)
static String	toFileNameString(Path p)
static String	toPathString(Path p)

Methods inherited from class org.autogui.swing.util.SearchTextField

add, addSearchItemsListener, convertIcon, createSearchTask, doActionButtons, getButtonsPane, getCurrentTask, getDynamicItemAction, getEditingRunner, getEditingRunnerDelay, getEmptyIcon, getField, getFocusColor, getIcon, getMenuItems, getModel, getPopup, getPopupButton, getPopupUpdateListener, getSearchedItems, getSearchedItemsListeners, initAfter, initBackgroundPainter, initField, initIcon, initLayout, initLayoutButtons, initLayoutButtonsPane, initPopupCategorized, isSwingEditable, isUpdateFieldImmediateEvent, isUpdateFieldImmediateEvent, isUpdateFieldModifiedEvents, paintComponent, removeSearchItemsListener, selectSearchedItemFromGui, selectSearchedItemFromModel, setBackground, setBackgroundWithoutInit, setCurrentSearchedItems, setCurrentSearchedItems, setIconFromSearchedItem, setTextWithoutUpdateField, setToolTipText, setTransferHandlerWithSettingExportingDragSource, setupCopyAndPaste, shutdown, updateField, updateFieldInEvent

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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

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, validate, 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, getAccessibleContext, 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, getName, 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, setName, 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 Details

MENU_CATEGORY_FILE_DEFAULT

public static String MENU_CATEGORY_FILE_DEFAULT

MENU_CATEGORY_FILE_CHILD

public static String MENU_CATEGORY_FILE_CHILD

MENU_CATEGORY_FILE_SIBLING

public static String MENU_CATEGORY_FILE_SIBLING

MENU_CATEGORY_FILE_PARENT

public static String MENU_CATEGORY_FILE_PARENT

MENU_CATEGORY_FILE_CURRENT

public static String MENU_CATEGORY_FILE_CURRENT

MENU_CATEGORY_FILE_CANDIDATE

public static String MENU_CATEGORY_FILE_CANDIDATE

Constructor Details

SearchTextFieldFilePath

public SearchTextFieldFilePath()

SearchTextFieldFilePath

public SearchTextFieldFilePath(SearchTextFieldFilePath.SearchTextFieldModelFilePath model)

Method Details

init

public void init()

Overrides:

init in class SearchTextField

initPopup

public void initPopup()

Overrides:

initPopup in class SearchTextField

initTransferHandler

public void initTransferHandler()

getMenuItemsSource

public List<Object> getMenuItemsSource()

Overrides:

getMenuItemsSource in class SearchTextField

Returns:

list of menu items including Action or JComponent

setFile

public void setFile(Path file)

the method is a simulated GUI task originally caused by the user. thus, it will cause a new background search task

Parameters:

file - the selected file

getFileItem

public SearchTextFieldFilePath.FileItem getFileItem(Path file)

getFile

public Path getFile()

isUpdateFieldModifiedEvent

public boolean isUpdateFieldModifiedEvent(Object e)

Overrides:

isUpdateFieldModifiedEvent in class SearchTextField

setTextFromSearchedItem

public void setTextFromSearchedItem(PopupCategorized.CategorizedMenuItem item)

Overrides:

setTextFromSearchedItem in class SearchTextField

toPathString

public static String toPathString(Path p)

toFileNameString

public static String toFileNameString(Path p)

formatFileSize

public static String formatFileSize(long size)