oracle.ide.component

Class NewFilePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.ide.component.NewFilePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.VetoableChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

FileBuilderPanel

public class NewFilePanel
extends javax.swing.JPanel
implements java.beans.VetoableChangeListener

The NewFilePanel class provides UI for specifying the location of a new file. Two fields are provided - one for the directory in which to create the new file, and one for the name of the file. The correct extension for the file will be ensured. A browse button is placed next to the directory field so that the user can select the directory using a chooser dialog.

Since:

9.0.3

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 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 and Description
NewFilePanel() Creates a new NewFilePanel instance.

Method Summary

Modifier and Type	Method and Description
protected void	addMoreComponents(java.awt.GridBagConstraints gbc) The method will serve as a hook for subclasses to add more components.
protected oracle.bali.ewt.dialog.DialogHeader	createDialogHeader() Creates the dialog header to use with this new file panel.
javax.swing.JButton	getBrowseButton()
javax.swing.JComponent	getDefaultFocusComponent()
javax.swing.JTextField	getDirectoryField()
javax.swing.JTextField	getFileField()
java.net.URL	getFileURL() Retrieves the URL of the file being specified in this dialog.
java.net.URL	getFileURL(boolean validateURL) Retrieves the URL of the file being specified in this dialog.
int	getLayoutOffset() Returns the layout left justification offset.
int	getLayoutOrientation() Returns the layout orientation.
NewFileValidator	getNewFileURLValidator() Retrieves the current NewFileValidator.
boolean	isFolderOK()
boolean	isSupportsAutoFill() Indicates whether the directory URL is created dynamically from the file name.
boolean	isValidChar(char newCharTyped)
void	requestFocus()
void	resetURLCache() Resets internal URL cache.
java.net.URL	runDialog(java.lang.String title) Creates and displays a dialog containing this NewFilePanel.
java.net.URL	runDialog(java.lang.String title, java.lang.Runnable runnable) Creates and displays a dialog containing this NewFilePanel which will call the supplied Runnable as the last vetoable change listener.
void	setAllowsEmptyFileName(boolean allowsEmptyFileName) Determines whether or not the file name can be a zero-length name plus an extension.
void	setBrowseButtonLabel(java.lang.String label)
void	setCanOverwriteOpenNodes(boolean canOverwriteOpenNodes) Specifies whether this NewFilePanel instance should allow the overwriting of open nodes.
void	setDefaultDirectoryName(java.net.URL rootFolderURL) Deprecated.
void	setDirectoryPrompt(java.lang.String prompt) Sets the label for the directory name text field.
void	setDirectoryURL(java.net.URL dir) Sets the URL used for the directory field.
void	setEnabled(boolean enabled) This disables all active children in the panel as well as the panel itself.
void	setEnforceFileExtension(boolean enforce) Sets whether or not to add the file extension no matter what (true), or to only add the extension if no extension is provided in the file name.
void	setFileExtension(java.lang.String ext) Sets the extension that should be used for the new file.
void	setFileName(java.lang.String fName) Sets the test to display in the file name field.
void	setFilePrompt(java.lang.String prompt) Set the label for the file name text field.
void	setFileType(java.lang.String type) Specifies a string used to describe the type of file.
void	setInteractiveMode(boolean isInteractive) Specifies whether this NewFilePanel is in interactive mode.
void	setLayoutOffset(int offset) Sets the padding offset used between labels and fields when orientation is HORIZONTAL Useful in compliance to UI guidelines in http://uistandards.us.oracle.com/desktopuiguide/index.html to help with left alignment.
void	setLayoutOrientation(int orientation) Sets the layout orientation of this panel.
void	setNewFileURLValidator(NewFileValidator validator) Specifies the NewFileValidator that will be used, in addition to the default validation, to make sure that the URL for the new File is valid.
void	setShowExtension(boolean show) Determines whether or not the file extension is shown in the file name field.
void	setSupportsAutoFill(boolean supportsAutoFill) Specifies whether the directory URL is created dynamically from the file name.
static java.net.URL	validateURL(java.awt.Component parent, java.net.URL tmpURL, java.lang.String type, boolean canOverwriteOpenNodes)
void	vetoableChange(java.beans.PropertyChangeEvent evt)

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, 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, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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

Constructor Detail

NewFilePanel

public NewFilePanel()

Creates a new NewFilePanel instance.

Method Detail

setLayoutOrientation

public final void setLayoutOrientation(int orientation)

Sets the layout orientation of this panel. The default orientation is SwingConstants.VERTICAL, which positions the labels above the fields. You can also make the orientation SwingConstants.HORIZONTAL which positions the labels to the left of the fields.

Parameters:

orientation - the layout orientation of this panel. Must be SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.

Throws:

java.lang.IllegalArgumentException - if orientation is not valid.

Since:

11.1.1

setLayoutOffset

public final void setLayoutOffset(int offset)

Sets the padding offset used between labels and fields when orientation is HORIZONTAL Useful in compliance to UI guidelines in http://uistandards.us.oracle.com/desktopuiguide/index.html to help with left alignment.

Parameters:

offset - padding used to left justify existing fields with those added by the client

Since:

12.1.1

getLayoutOffset

public final int getLayoutOffset()

Returns the layout left justification offset. This is 0 by default.

Returns:

offset

Since:

12.1.1

getLayoutOrientation

public final int getLayoutOrientation()

Returns the layout orientation. This is SwingConstants.VERTICAL by default.

Returns:

either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.

Since:

11.1.1

createDialogHeader

protected oracle.bali.ewt.dialog.DialogHeader createDialogHeader()

Creates the dialog header to use with this new file panel.

This implementation returns null

Returns:

a dialog header to use with this new file panel. If null is returned, no header is used.

Since:

11.0

setSupportsAutoFill

public void setSupportsAutoFill(boolean supportsAutoFill)

Specifies whether the directory URL is created dynamically from the file name. By default, NewFilePanel is in interactive mode.

Parameters:

supportsAutoFill - true to turn auto-fill on, false to turn it off

isSupportsAutoFill

public boolean isSupportsAutoFill()

Indicates whether the directory URL is created dynamically from the file name.

Returns:

true if auto-fill on, false if it's off

setInteractiveMode

public void setInteractiveMode(boolean isInteractive)

Specifies whether this NewFilePanel is in interactive mode. When in interactive mode, errors are reported to the user; when not in interactive mode, errors are suppressed.

By default, NewFilePanel is in interactive mode.

setFileExtension

public void setFileExtension(java.lang.String ext)

Sets the extension that should be used for the new file.

setEnforceFileExtension

public void setEnforceFileExtension(boolean enforce)

Sets whether or not to add the file extension no matter what (true), or to only add the extension if no extension is provided in the file name.

Parameters:

enforce -

setFileType

public void setFileType(java.lang.String type)

Specifies a string used to describe the type of file. This string is used in error messages. NewProjectFile UI might specify a FileType of project file", for example.

setNewFileURLValidator

public void setNewFileURLValidator(NewFileValidator validator)

Specifies the NewFileValidator that will be used, in addition to the default validation, to make sure that the URL for the new File is valid. The validator, for example, could be used to ensure that a JSP filename is valid.

Parameters:

validator - the NewFileValidator to use, or null to only use the default validation.

getNewFileURLValidator

public NewFileValidator getNewFileURLValidator()

Retrieves the current NewFileValidator.

Returns:

the current NewFileValidator.

setCanOverwriteOpenNodes

public void setCanOverwriteOpenNodes(boolean canOverwriteOpenNodes)

Specifies whether this NewFilePanel instance should allow the overwriting of open nodes. If it is allowed, the user will be asked if she wants to overwrite the file; if it is not allowed, an error will be reported.

By default, NewFilePanel can overwrite open nodes.

runDialog

public java.net.URL runDialog(java.lang.String title)

Creates and displays a dialog containing this NewFilePanel.

Parameters:

title - the title to use for the dialog

Returns:

the URL of the file specified by the user, or null if the user canceled the dialog.

runDialog

public java.net.URL runDialog(java.lang.String title,
                              java.lang.Runnable runnable)

Creates and displays a dialog containing this NewFilePanel which will call the supplied Runnable as the last vetoable change listener.

Parameters:

title - the title to use for the dialog

runnable - to run when the dialog is ok'ed

Returns:

the URL of the file specified by the user, or null if the user canceled the dialog.

resetURLCache

public void resetURLCache()

Resets internal URL cache.

getFileURL

public java.net.URL getFileURL()
                        throws TraversalException

Retrieves the URL of the file being specified in this dialog.

Returns:

the URL of the file

Throws:

TraversalException - if an error is encountered in determining the URL.

getFileURL

public java.net.URL getFileURL(boolean validateURL)
                        throws TraversalException

Retrieves the URL of the file being specified in this dialog.

Parameters:

validateURL - true if the url should be validated; false otherwise. The only time false should be passed is when you know the validation has already been performed once and you don't want to do it again.

Returns:

the URL of the file

Throws:

TraversalException - if an error is encountered in determining the URL.

isFolderOK

public boolean isFolderOK()

validateURL

public static java.net.URL validateURL(java.awt.Component parent,
                                       java.net.URL tmpURL,
                                       java.lang.String type,
                                       boolean canOverwriteOpenNodes)
                                throws TraversalException

Throws:

TraversalException

setDirectoryURL

public void setDirectoryURL(java.net.URL dir)

Sets the URL used for the directory field.

setDefaultDirectoryName

public void setDefaultDirectoryName(java.net.URL rootFolderURL)

Deprecated.

Resets the directory text field to use the default, and sets the text in the directory field to rootFolderURL + the file name.

setFileName

public void setFileName(java.lang.String fName)

Sets the test to display in the file name field. If isShowExtension returns true, the file extension is appended to the file name. By default, the extension is not shown.

Parameters:

fName - the file name

See Also:

setFileExtension(String), setShowExtension(boolean)

setShowExtension

public void setShowExtension(boolean show)

Determines whether or not the file extension is shown in the file name field.

Parameters:

show - If true, the extension is appended to the file name in the file name text field, otherwise, the extension is not shown

setAllowsEmptyFileName

public void setAllowsEmptyFileName(boolean allowsEmptyFileName)

Determines whether or not the file name can be a zero-length name plus an extension. Note that an empty string without an extension is not a valid file name.

Parameters:

allowsEmptyFileName - if true the file name can be empty as long as the file has an extension; if false, a non-empty file name is required.

setDirectoryPrompt

public void setDirectoryPrompt(java.lang.String prompt)

Sets the label for the directory name text field.

Parameters:

prompt - the label

setFilePrompt

public void setFilePrompt(java.lang.String prompt)

Set the label for the file name text field.

Parameters:

prompt - the label

setBrowseButtonLabel

public void setBrowseButtonLabel(java.lang.String label)

getDefaultFocusComponent

public javax.swing.JComponent getDefaultFocusComponent()

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

getDirectoryField

public javax.swing.JTextField getDirectoryField()

getFileField

public javax.swing.JTextField getFileField()

getBrowseButton

public javax.swing.JButton getBrowseButton()

vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent evt)
                    throws java.beans.PropertyVetoException

Specified by:

vetoableChange in interface java.beans.VetoableChangeListener

Throws:

java.beans.PropertyVetoException

addMoreComponents

protected void addMoreComponents(java.awt.GridBagConstraints gbc)

The method will serve as a hook for subclasses to add more components. They may serve to show additional information about side effects, caveats created as a result of the new file.

isValidChar

public boolean isValidChar(char newCharTyped)

setEnabled

public void setEnabled(boolean enabled)

This disables all active children in the panel as well as the panel itself.

Overrides:

setEnabled in class javax.swing.JComponent