org.trianacode.gui.panels

Class FilePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.trianacode.gui.panels.ParameterPanel

org.trianacode.gui.panels.FilePanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, WindowButtonConstants, TaskListener

public class FilePanel
extends ParameterPanel
implements java.awt.event.ActionListener, java.awt.event.FocusListener

A parameter panel for specifying input files

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_FILTER
static java.lang.String	FILE_NAME
static java.lang.String	FILE_NAME_TEXT
static java.lang.String	PATH_TEXT

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.trianacode.gui.windows.WindowButtonConstants

NO_BUTTONS, OK_BUTTON, OK_CANCEL_APPLY_BUTTONS, OK_CANCEL_BUTTONS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FilePanel()

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Browse using a file dialog
void	applyClicked() Called when the apply button is clicked on the parameter window.
void	dispose() This method is called when the panel is finished with.
void	focusGained(java.awt.event.FocusEvent event)
void	focusLost(java.awt.event.FocusEvent event)
java.lang.String	getFilenameParam() Sets the name of the parameter that the filename is stored in
java.lang.String	getFilenameText()
java.lang.String	getFilter()
java.lang.String	getPathText()
byte	getPreferredButtons() This method returns WindowButtonConstants.OK_CANCEL_APPLY_BUTTONS by default.
void	init() Initialise user interface
boolean	isAutoCommitVisible() This method returns true by default.
void	okClicked() Called when the ok button is clicked on the parameter window.
void	reset() Resets the user interface to the parameter values stored in the task
void	setAutoCommitVisible(boolean state) Sets whether the autocommit checkbox is visible
void	setFilenameParam(java.lang.String filenameparam)
void	setFilenameText(java.lang.String filenametxt) Sets the filename text
void	setFilter(java.lang.String filter) Sets the filename filter
void	setPathText(java.lang.String pathtxt) Sets the path text
void	setPreferredButtons(byte buttons) Sets the preferred buttons for this panel (as defined in WindowButtonConstants)

Methods inherited from class org.trianacode.gui.panels.ParameterPanel

cancelClicked, disposePanel, getMenuBar, getParameter, getTask, getWindow, getWindowInterface, isAlwaysOnTopPreferred, isAutoCommit, isAutoCommitByDefault, isParameterName, nodeAdded, nodeRemoved, parameterUpdate, parameterUpdated, removeParameter, setMenuBar, setParameter, setTask, setWindowInterface, taskDisposed, taskPropertyUpdate

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

FILE_FILTER

public static final java.lang.String FILE_FILTER

See Also:

Constant Field Values

FILE_NAME

public static final java.lang.String FILE_NAME

See Also:

Constant Field Values

FILE_NAME_TEXT

public static final java.lang.String FILE_NAME_TEXT

See Also:

Constant Field Values

PATH_TEXT

public static final java.lang.String PATH_TEXT

See Also:

Constant Field Values

Constructor Detail

FilePanel

public FilePanel()

Method Detail

getFilter

public java.lang.String getFilter()

setFilter

public void setFilter(java.lang.String filter)

Sets the filename filter

getFilenameText

public java.lang.String getFilenameText()

setFilenameText

public void setFilenameText(java.lang.String filenametxt)

Sets the filename text

getPathText

public java.lang.String getPathText()

setPathText

public void setPathText(java.lang.String pathtxt)

Sets the path text

getFilenameParam

public java.lang.String getFilenameParam()

Sets the name of the parameter that the filename is stored in

setFilenameParam

public void setFilenameParam(java.lang.String filenameparam)

setPreferredButtons

public void setPreferredButtons(byte buttons)

Sets the preferred buttons for this panel (as defined in WindowButtonConstants)

getPreferredButtons

public byte getPreferredButtons()

Description copied from class: ParameterPanel

This method returns WindowButtonConstants.OK_CANCEL_APPLY_BUTTONS by default. It should be overridden if the panel has different preferred set of buttons.

Overrides:

getPreferredButtons in class ParameterPanel

Returns:

the preferred set of buttons for this panel

setAutoCommitVisible

public void setAutoCommitVisible(boolean state)

Sets whether the autocommit checkbox is visible

isAutoCommitVisible

public boolean isAutoCommitVisible()

This method returns true by default. It should be overridden if the panel does not want the user to be able to change the auto commit state

Overrides:

isAutoCommitVisible in class ParameterPanel

init

public void init()

Initialise user interface

Specified by:

init in class ParameterPanel

reset

public void reset()

Resets the user interface to the parameter values stored in the task

Specified by:

reset in class ParameterPanel

dispose

public void dispose()

Description copied from class: ParameterPanel

This method is called when the panel is finished with. It should dispose of any components (e.g. windows) used by the panel.

Specified by:

dispose in class ParameterPanel

okClicked

public void okClicked()

Called when the ok button is clicked on the parameter window. Commits any parameter changes.

Overrides:

okClicked in class ParameterPanel

applyClicked

public void applyClicked()

Called when the apply button is clicked on the parameter window. Commits any parameter changes.

Overrides:

applyClicked in class ParameterPanel

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Browse using a file dialog

Specified by:

actionPerformed in interface java.awt.event.ActionListener

focusGained

public void focusGained(java.awt.event.FocusEvent event)

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent event)

Specified by:

focusLost in interface java.awt.event.FocusListener