Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

oracle.ide.net
Class URLTextField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.text.JTextComponent
                  extended by javax.swing.JTextField
                      extended by oracle.javatools.controls.completionfield.CompletionTextField
                          extended by oracle.javatools.controls.FileField
                              extended by oracle.ide.net.URLTextField
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants, CompletionTextComponent

public class URLTextField
extends FileField
implements java.awt.event.ActionListener

This is a subclass of JTextField that is intended to hold a single URL. The user is allowed to type freely into the text field, and the text will be converted into an URL when the getURL() method is called; if the string cannot be converted into an URL for whatever reason, getURL() returns null.

As a convenience, URLTextField also implements ActionListener. This is intended to be used by "Browse..." buttons whose action is to bring up the URLChooser to select an appropriate file/directory. Such a button just needs to set the URLTextField instance as its ActionListener.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JTextField
javax.swing.JTextField.AccessibleJTextField
 
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
 
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
static int OPEN_DIALOG
          Dialog type constant indicating that the URL chooser invoked through this field should be an open dialog.
static int SAVE_DIALOG
          Dialog type constant indicating that the URL chooser invoked through this field should be a save dialog.
 
Fields inherited from class javax.swing.JTextField
notifyAction
 
Fields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
 
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
URLTextField()
          Creates an empty URLTextField that is configured to handle a directory URL.
URLTextField(java.net.URL url)
          Creates a new URLTextField whose displayed value reflects the specified URL, which is interpreted as representing a directory.
URLTextField(java.net.URL url, boolean isDir)
           
URLTextField(java.net.URL url, boolean isDir, boolean showJarsAsDirs)
           
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Convenience implementation for allowing buttons to set the URLTextField as their ActionListener.
 void addChooseableURLFilter(URLFilter filter)
          Adds a URLFilter to the "File types" filter combo box.
 boolean browseForURL()
          Pops up a URLChooser that allows the user to browse for the URL.
 void clearChooseableURLFilters()
          Clears the list of URLFilters in the "File types" filter combo box.
protected  URLChooser createChooser(java.net.URL url)
          Creates a URL chooser initialized to the URL displayed in this field.
 URLChooserInit getChooserInit()
          Retrieves the current filter for browsing new URLs
 int getDialogType()
          Gets whether the URL chooser displayed through this text field is an Open dialog or a Save dialog.
 URLFilter getFilter()
          Retrieves the current filter for browsing new URLs
 java.net.URL getURL()
          Returns an URL corresponding to the text that is currently displayed in the text field.
 boolean isDirectoryOnly()
          Whether the URLTextField is displaying a directory or a file.
static URLTextField newForSavingFile()
          Convenience method for a common configuration of URLTextField.
 void setBaseURL(java.net.URL baseURL)
          This is an undocumented feature.
 void setChooserInit(URLChooserInit chooserInit)
          Specifies a URLChooserInit to use when browsing for new URLs.
 void setClearAllFilters(boolean clearFilters)
          Deprecated. Replaced by clearChooseableURLFilters().
 void setDefaultChooserURL(java.net.URL url)
           
 void setDialogHelpContext(java.lang.String helpContext)
           
 void setDialogTitle(java.lang.String title)
          Sets the title to use for the browse dialog
 void setDialogType(int type)
          Sets whether the URL chooser displayed through this text field is an Open dialog or a Save dialog.
 void setDirectoryOnly(boolean isDir)
          Specifies whether this URLTextField should display directories or files.
 void setFilter(URLFilter filter)
          Specifies a filter to use when browsing for new URLs.
 void setURL(java.net.URL url)
          Sets the URL displayed in the URLTextField.
 
Methods inherited from class oracle.javatools.controls.FileField
getInsightProvider, isOnlyDirectories, isTextValid, isValidateExistingFile, setOnlyDirectories, setValidateExistingFile
 
Methods inherited from class oracle.javatools.controls.completionfield.CompletionTextField
getInvalidCharacterRanges, getPopupHandler, paintComponent, removeNotify, setAlignWithField, setInsightVisible, setText, setWidthOfField
 
Methods inherited from class javax.swing.JTextField
actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write
 
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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, 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, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPEN_DIALOG

public static final int OPEN_DIALOG
Dialog type constant indicating that the URL chooser invoked through this field should be an open dialog.

See Also:
Constant Field Values

SAVE_DIALOG

public static final int SAVE_DIALOG
Dialog type constant indicating that the URL chooser invoked through this field should be a save dialog.

See Also:
Constant Field Values
Constructor Detail

URLTextField

public URLTextField()
Creates an empty URLTextField that is configured to handle a directory URL.


URLTextField

public URLTextField(java.net.URL url)
Creates a new URLTextField whose displayed value reflects the specified URL, which is interpreted as representing a directory. If the URL is null, then the text field will be initially empty. If the URL that the text field displays is for a file, you must use the URLTextField(URL, boolean) constructor instead.


URLTextField

public URLTextField(java.net.URL url,
                    boolean isDir)
Parameters:
url - The initial URL to show in the text field. This may be null, which means the text field will be initially empty.
isDir - If true the URL returned by the getURL() method will be an URL for a directory; otherwise, it will be an URL for a file.

URLTextField

public URLTextField(java.net.URL url,
                    boolean isDir,
                    boolean showJarsAsDirs)
Parameters:
url - The initial URL to show in the text field. This may be null, which means the text field will be initially empty.
isDir - If true the URL returned by the getURL() method will be an URL for a directory; otherwise, it will be an URL for a file.
showJarsAsDirs - If true the dialog will show jar files in the directory list.
Method Detail

newForSavingFile

public static URLTextField newForSavingFile()
Convenience method for a common configuration of URLTextField. This returns a URLTextField that is used to prompt the user for an output (save) URL. It is equivalent to calling new URLTextField( null, false, false );


getURL

public java.net.URL getURL()
Returns an URL corresponding to the text that is currently displayed in the text field.


setURL

public void setURL(java.net.URL url)
Sets the URL displayed in the URLTextField.


isDirectoryOnly

public boolean isDirectoryOnly()
Whether the URLTextField is displaying a directory or a file.

Returns:
true if the URL displayed by this field should be a directory.

setDirectoryOnly

public void setDirectoryOnly(boolean isDir)
Specifies whether this URLTextField should display directories or files.

Parameters:
isDir - whether the URL displayed by this URLTextField should be a directory.

setClearAllFilters

public void setClearAllFilters(boolean clearFilters)
Deprecated. Replaced by clearChooseableURLFilters().


setDefaultChooserURL

public void setDefaultChooserURL(java.net.URL url)

addChooseableURLFilter

public void addChooseableURLFilter(URLFilter filter)
Adds a URLFilter to the "File types" filter combo box.

See Also:
URLChooser.addChooseableURLFilter(URLFilter)

clearChooseableURLFilters

public void clearChooseableURLFilters()
Clears the list of URLFilters in the "File types" filter combo box.

See Also:
URLChooser.clearChooseableURLFilters()

getFilter

public URLFilter getFilter()
Retrieves the current filter for browsing new URLs

Returns:
the current filter

setFilter

public void setFilter(URLFilter filter)
Specifies a filter to use when browsing for new URLs.

Parameters:
filter - the filter to use

setDialogType

public void setDialogType(int type)
Sets whether the URL chooser displayed through this text field is an Open dialog or a Save dialog.


getDialogType

public int getDialogType()
Gets whether the URL chooser displayed through this text field is an Open dialog or a Save dialog.


getChooserInit

public URLChooserInit getChooserInit()
Retrieves the current filter for browsing new URLs

Returns:
the current filter

setChooserInit

public void setChooserInit(URLChooserInit chooserInit)
Specifies a URLChooserInit to use when browsing for new URLs.

Parameters:
chooserInit - the URLChooserInit to use

setBaseURL

public void setBaseURL(java.net.URL baseURL)
This is an undocumented feature.


setDialogTitle

public void setDialogTitle(java.lang.String title)
Sets the title to use for the browse dialog


setDialogHelpContext

public void setDialogHelpContext(java.lang.String helpContext)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Convenience implementation for allowing buttons to set the URLTextField as their ActionListener. When the action event is triggered, the user will be prompted to browse for a directory using the URLChooser.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

browseForURL

public boolean browseForURL()
Pops up a URLChooser that allows the user to browse for the URL. The URLChooser will come up in either FILES_ONLY mode or in DIRECTORIES_ONLY mode depending on the isDir flag that was passed into the URLTextField constructor.


createChooser

protected URLChooser createChooser(java.net.URL url)
Creates a URL chooser initialized to the URL displayed in this field.

Parameters:
url - The initial URL to select in the chooser.

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

Copyright © 1997, 2010, Oracle. All rights reserved.