javax.swing
Class JComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent

All Implemented Interfaces:

ImageObserver , MenuContainer , Serializable

Direct Known Subclasses:

AbstractButton , BasicInternalFrameTitlePane , Box , Box.Filler , JColorChooser , JComboBox , JFileChooser , JInternalFrame , JInternalFrame.JDesktopIcon , JLabel , JLayeredPane , JList , JMenuBar , JOptionPane , JPanel , JPopupMenu , JProgressBar , JRootPane , JScrollBar , JScrollPane , JSeparator , JSlider , JSpinner , JSplitPane , JTabbedPane , JTable , JTableHeader , JTextComponent , JToolBar , JToolTip , JTree , JViewport

public abstract class JComponent

extends Container

implements Serializable

The base class for all Swing components except top-level containers. To use a component that inherits from JComponent, you must place the component in a containment hierarchy whose root is a top-level Swing container. Top-level Swing containers -- such as JFrame, JDialog, and JApplet -- are specialized components that provide a place for other Swing components to paint themselves. For an explanation of containment hierarchies, see Swing Components and the Containment Hierarchy , a section in The Java Tutorial.

The JComponent class provides:

• The base class for both standard and custom components that use the Swing architecture.
• A "pluggable look and feel" (L&F) that can be specified by the programmer or (optionally) selected by the user at runtime. The look and feel for each component is provided by a UI delegate -- an object that descends from ComponentUI . See How to Set the Look and Feel in The Java Tutorial for more information.
• Comprehensive keystroke handling. See the document Keyboard Bindings in Swing , an article in The Swing Connection, for more information.
• Support for tool tips -- short descriptions that pop up when the cursor lingers over a component. See How to Use Tool Tips in The Java Tutorial for more information.
• Support for accessibility. JComponent contains all of the methods in the Accessible interface, but it doesn't actually implement the interface. That is the responsibility of the individual classes that extend JComponent.
• Support for component-specific properties. With the putClientProperty(java.lang.Object, java.lang.Object) and getClientProperty(java.lang.Object) methods, you can associate name-object pairs with any object that descends from JComponent.
• An infrastructure for painting that includes double buffering and support for borders. For more information see Painting and How to Use Borders , both of which are sections in The Java Tutorial.

JComponent and its subclasses document default values for certain properties. For example, JTable documents the default row height as 16. Each JComponent subclass that has a ComponentUI will create the ComponentUI as part of its constructor. In order to provide a particular look and feel each ComponentUI may set properties back on the JComponent that created it. For example, a custom look and feel may require JTables to have a row height of 24. The documented defaults are the value of a property BEFORE the ComponentUI has been installed. If you need a specific value for a particular property you should explicitly set it.

In release 1.4, the focus subsystem was rearchitected. For more information, see How to Use the Focus Subsystem , a section in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans ^TM has been added to the java.beans package. Please see XMLEncoder .

See Also:

KeyStroke , Action , setBorder(javax.swing.border.Border) , registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int) , JOptionPane , setDebugGraphicsOptions(int) , setToolTipText(java.lang.String) , setAutoscrolls(boolean)

Nested Class Summary
class	JComponent.AccessibleJComponent           Inner class of JComponent used to provide default support for accessibility.

 

Nested classes inherited from class java.awt. Container
Container.AccessibleAWTContainer

 

Nested classes inherited from class java.awt. Component
Component.AccessibleAWTComponent , Component.BltBufferStrategy , Component.FlipBufferStrategy

 

Field Summary
protected   AccessibleContext	accessibleContext           The AccessibleContext associated with this JComponent.
protected   EventListenerList	listenerList           A list of event listeners for this component.
static  String	TOOL_TIP_TEXT_KEY           The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".
protected   ComponentUI	ui           The look and feel delegate for this component.
static int	UNDEFINED_CONDITION           Constant used by some of the APIs to mean that no condition is defined.
static int	WHEN_ANCESTOR_OF_FOCUSED_COMPONENT           Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.
static int	WHEN_FOCUSED           Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus.
static int	WHEN_IN_FOCUSED_WINDOW           Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.

 

Fields inherited from class java.awt. Component
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
JComponent ()           Default JComponent constructor.

 

Method Summary
void	addAncestorListener ( AncestorListener  listener)           Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible.
void	addNotify ()           Notifies this component that it now has a parent component.
void	addPropertyChangeListener ( PropertyChangeListener           Adds a PropertyChangeListener to the listener list.
void	addPropertyChangeListener ( String  propertyName, PropertyChangeListener           Adds a PropertyChangeListener for a specific property.
void	addVetoableChangeListener ( VetoableChangeListener  listener)           Adds a VetoableChangeListener to the listener list.
void	computeVisibleRect ( Rectangle  visibleRect)           Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
boolean	contains (int x, int y)           Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.
JToolTip	createToolTip ()           Returns the instance of JToolTip that should be used to display the tooltip.
void	disable ()            Deprecated.   As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). java.awt.Component.setEnable(boolean).
void	enable ()            Deprecated.   As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). java.awt.Component.setEnable(boolean).
void	firePropertyChange ( String           Support for reporting           Reports a bound property changes for boolean properties. change.
void	firePropertyChange ( String           Reports a bound property change.
void	firePropertyChange ( String  propertyName, char oldValue, char newValue)           Reports a bound property change.
void	firePropertyChange firePropertyChange ( String           Support for reporting           Reports a bound property changes for integer properties. change.
void	firePropertyChange ( String           Reports a bound property change.
void	firePropertyChange ( String           Reports a bound property change.
void	firePropertyChange ( String           Reports a bound property change.
protected  void	firePropertyChange ( String  propertyName, Object  oldValue, Object           Supports reporting bound property changes.
void	firePropertyChange ( String           Reports a bound property change.
protected  void	fireVetoableChange ( String  propertyName, Object  oldValue, Object  newValue)           Supports reporting constrained property changes.
AccessibleContext	getAccessibleContext ()           Returns the AccessibleContext associated with this JComponent.
ActionListener	getActionForKeyStroke ( KeyStroke  aKeyStroke)           Returns the object that will perform the action registered for a given keystroke.
ActionMap	getActionMap ()           Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding.
float	getAlignmentX ()           Overrides Container.getAlignmentX to return the vertical alignment.
float	getAlignmentY ()           Overrides Container.getAlignmentY to return the horizontal alignment.
AncestorListener []	getAncestorListeners ()           Returns an array of all the ancestor listeners registered on this component.
boolean	getAutoscrolls ()           Gets the autoscrolls property.
Border	getBorder ()           Returns the border of this component or null if no border is currently set.
Rectangle	getBounds ( Rectangle  rv)           Stores the bounds of this component into "return value" rv and returns rv.
Object	getClientProperty ( Object  key)           Returns the value of the property with the specified key.
protected   Graphics	getComponentGraphics ( Graphics  g)           Returns the graphics object used to paint this component.
JPopupMenu	getComponentPopupMenu ()           Returns JPopupMenu that assigned for this component.
int	getConditionForKeyStroke ( KeyStroke  aKeyStroke)           Returns the condition that determines whether a registered action occurs in response to the specified keystroke.
int	getDebugGraphicsOptions ()           Returns the state of graphics debugging.
static  Locale	getDefaultLocale ()           Returns the default locale used to initialize each JComponent's locale property upon creation.
FontMetrics	getFontMetrics ( Font           Gets the FontMetrics for the specified Font.
Graphics	getGraphics ()           Returns this component's graphics context, which lets you draw on a component.
int	getHeight ()           Returns the current height of this component.
boolean	getInheritsPopupMenu ()           Returns true if the JPopupMenu should be inherited from the parent.
InputMap	getInputMap ()           Returns the InputMap that is used when the component has focus.
InputMap	getInputMap (int condition)           Returns the InputMap that is used during condition.
InputVerifier	getInputVerifier ()           Returns the input verifier for this component.
Insets	getInsets ()           If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets.
Insets	getInsets ( Insets  insets)           Returns an Insets object containing this component's inset values.
EventListener []	getListeners ( Class  listenerType)           Returns an array of all the objects currently registered as FooListeners upon this JComponent.
Point	getLocation ( Point  rv)           Stores the x,y origin of this component into "return value" rv and returns rv.
Dimension	getMaximumSize ()           If the maximum size has been set to a non-null value just returns it.
Dimension	getMinimumSize ()           If the minimum size has been set to a non-null value just returns it.
Component	getNextFocusableComponent ()            Deprecated.   As of 1.4, replaced by FocusTraversalPolicy.
Point	getPopupLocation ( MouseEvent           Returns the preferred location to display the popup menu in this component's coordinate system.
Dimension	getPreferredSize ()           If the preferredSize has been set to a non-null value just returns it.
Dimension PropertyChangeListener	getPreferredSize getPropertyChangeListeners ()           If           Returns an array of all the preferredSize has been set PropertyChangeListeners added to a non-null value just returns it. this Component with addPropertyChangeListener().
PropertyChangeListener	getPropertyChangeListeners ( String           Returns an array of all the listeners which have been associated with the named property.
KeyStroke []	getRegisteredKeyStrokes ()           Returns the KeyStrokes that will initiate registered actions.
JRootPane	getRootPane ()           Returns the JRootPane ancestor for this component.
Dimension	getSize ( Dimension  rv)           Stores the width/height of this component into "return value" rv and returns rv.
Point	getToolTipLocation ( MouseEvent  event)           Returns the tooltip location in this component's coordinate system.
String	getToolTipText ()           Returns the tooltip string that has been set with setToolTipText.
String	getToolTipText ( MouseEvent  event)           Returns the string to be used as the tooltip for event .
Container	getTopLevelAncestor ()           Returns the top-level ancestor of this component (either the containing Window or Applet), or null if this component has not been added to any container.
TransferHandler	getTransferHandler ()           Gets the transferHandler property.
String	getUIClassID ()           Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component.
boolean	getVerifyInputWhenFocusTarget ()           Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.
VetoableChangeListener []	getVetoableChangeListeners ()           Returns an array of all the vetoable change listeners registered on this component.
Rectangle	getVisibleRect ()           Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle, new Rectangle(0, 0, getWidth(), getHeight()), and all of its ancestors' visible rectangles. rectangle:
int	getWidth ()           Returns the current width of this component.
int	getX ()           Returns the current x coordinate of the component's origin.
int	getY ()           Returns the current y coordinate of the component's origin.
void	grabFocus ()           Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	isDoubleBuffered ()           Returns whether this component should use a buffer to paint.
static boolean	isLightweightComponent ( Component  c)           Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.
boolean	isManagingFocus ()            Deprecated.   As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean).
boolean	isMaximumSizeSet ()           Returns true if the maximum size has been set to a non-null value otherwise returns false.
boolean	isMinimumSizeSet ()           Returns true if the minimum size has been set to a non-null value otherwise returns false.
boolean	isOpaque ()           Returns true if this component is completely opaque.
boolean	isOptimizedDrawingEnabled ()           Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.
boolean	isPaintingTile ()           Returns true if the component is currently painting a tile.
boolean	isPreferredSizeSet ()           Returns true if the preferred size has been set to a non-null value otherwise returns false.
boolean	isRequestFocusEnabled ()           Returns true if this JComponent should get focus; otherwise returns false.
boolean	isValidateRoot ()           If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated.
void	paint ( Graphics  g)           Invoked by Swing to draw components.
protected  void	paintBorder ( Graphics  g)           Paints the component's border.
protected  void	paintChildren ( Graphics  g)           Paints this component's children.
protected  void	paintComponent ( Graphics  g)           Calls the UI delegate's paint method, if the UI delegate is non-null.
void	paintImmediately (int x, int y, int w, int h)           Paints the specified region in this component and all of its descendants that overlap the region, immediately.
void	paintImmediately ( Rectangle  r)           Paints the specified region now.
protected   String	paramString ()           Returns a string representation of this JComponent.
void	print ( Graphics  g)           Invoke this method to print the component.
void	printAll ( Graphics  g)           Invoke this method to print the component.
protected  void	printBorder ( Graphics  g)           Prints the component's border.
protected  void	printChildren ( Graphics  g)           Prints this component's children.
protected  void	printComponent ( Graphics  g)           This is invoked during a printing operation.
protected  void	processComponentKeyEvent ( KeyEvent  e)           Processes any key events that the component itself recognizes.
protected  boolean	processKeyBinding ( KeyStroke  ks, KeyEvent  e, int condition, boolean pressed)           Invoked to process the key bindings for ks as the result of the KeyEvent e.
protected  void	processKeyEvent ( KeyEvent  e)           Overrides processKeyEvent to process events.
protected  void	processMouseEvent ( MouseEvent           Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects, refer to Component.processMouseEvent(MouseEvent)
protected  void	processMouseMotionEvent ( MouseEvent  e)           Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
void	putClientProperty ( Object  key, Object  value)           Adds an arbitrary key/value "client property" to this component.
void	registerKeyboardAction ( ActionListener  anAction, KeyStroke  aKeyStroke, int aCondition)           This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior.
void	registerKeyboardAction ( ActionListener  anAction, String  aCommand, KeyStroke  aKeyStroke, int aCondition)           This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior.
void	removeAncestorListener ( AncestorListener  listener)           Unregisters listener so that it will no longer receive AncestorEvents.
void	removeNotify ()           Notifies this component that it no longer has a parent component.
void	removePropertyChangeListener ( PropertyChangeListener           Removes a PropertyChangeListener from the listener list.
void	removePropertyChangeListener ( String  propertyName, PropertyChangeListener           Removes a PropertyChangeListener for a specific property.
void	removeVetoableChangeListener ( VetoableChangeListener  listener)           Removes a VetoableChangeListener from the listener list.
void	repaint (long tm, int x, int y, int width, int height)           Adds the specified region to the dirty region list if the component is showing.
void	repaint ( Rectangle  r)           Adds the specified region to the dirty region list if the component is showing.
boolean	requestDefaultFocus ()            Deprecated.   As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()
void	requestFocus ()           Requests that this Component gets get the input focus. focus, and that this Component's top-level ancestor become the focused Window.
boolean	requestFocus (boolean temporary)           Requests           JComponent overrides requestFocus solely to make the method public so that this Component gets the input focus. UI implementations can cause temporary focus changes.
boolean	requestFocusInWindow ()           Requests that this Component gets get the input focus. focus, if this Component's top-level ancestor is already the focused Window.
protected  boolean	requestFocusInWindow (boolean temporary)           Requests           JComponent overrides requestFocusInWindow solely to make the method public so that this Component gets the input focus. UI implementations can cause temporary focus changes.
void	resetKeyboardActions ()           Unregisters all the bindings in the first tier InputMaps and ActionMap.
void	reshape (int x, int y, int w, int h)            Deprecated.   As of JDK version 1.5, replaced by Component.setBounds(int, int, int, int). Moves           Moves and resizes this component.
void	revalidate ()           Supports deferred automatic layout.
void	scrollRectToVisible ( Rectangle  aRect)           Forwards the scrollRectToVisible() message to the JComponent's parent.
void	setActionMap ( ActionMap  am)           Sets the ActionMap to am.
void	setAlignmentX (float alignmentX)           Sets the the vertical alignment.
void	setAlignmentY (float alignmentY)           Sets the the horizontal alignment.
void	setAutoscrolls (boolean autoscrolls)           Sets the autoscrolls property.
void	setBackground ( Color  bg)           Sets the background color of this component.
void	setBorder ( Border  border)           Sets the border of this component.
void	setComponentPopupMenu ( JPopupMenu           Sets the JPopupMenu for this JComponent.
void	setDebugGraphicsOptions (int debugOptions)           Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
static void	setDefaultLocale ( Locale  l)           Sets the default locale used to initialize each JComponent's locale property upon creation.
void	setDoubleBuffered (boolean aFlag)           Sets whether the this component should use a buffer to paint.
void	setEnabled (boolean enabled)           Sets whether or not this component is enabled.
void	setFocusTraversalKeys (int id, Set           Sets the focus traversal keys for a given traversal operation for this Component.
void	setFont ( Font  font)           Sets the font for this component.
void	setForeground ( Color  fg)           Sets the foreground color of this component.
void	setInheritsPopupMenu (boolean value)           Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it.
void	setInputMap (int condition, InputMap  map)           Sets the InputMap to use under the condition condition to map.
void	setInputVerifier ( InputVerifier  inputVerifier)           Sets the input verifier for this component.
void	setMaximumSize ( Dimension  maximumSize)           Sets the maximum size of this component to a constant value.
void	setMinimumSize ( Dimension  minimumSize)           Sets the minimum size of this component to a constant value.
void	setNextFocusableComponent ( Component  aComponent)            Deprecated.   As of 1.4, replaced by FocusTraversalPolicy
void	setOpaque (boolean isOpaque)           If true the component paints every pixel within its bounds.
void	setPreferredSize ( Dimension  preferredSize)           Sets the preferred size of this component.
void	setRequestFocusEnabled (boolean requestFocusEnabled)           Provides a hint as to whether or not this JComponent should get focus.
void	setToolTipText ( String  text)           Registers the text to display in a tool tip.
void	setTransferHandler ( TransferHandler  newHandler)           Sets the transferHandler property, which is null if the component does not support data transfer operations.
protected  void	setUI ( ComponentUI  newUI)           Sets the look and feel delegate for this component.
void	setVerifyInputWhenFocusTarget (boolean verifyInputWhenFocusTarget)           Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
void	setVisible (boolean aFlag)           Makes the component visible or invisible.
void	unregisterKeyboardAction ( KeyStroke  aKeyStroke)           This method is now obsolete.
void	update ( Graphics  g)           Calls paint.
void	updateUI ()           Resets the UI property to a value from the current look and feel.

 

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 , setFocusCycleRoot setFocusTraversalKeys , setFocusTraversalPolicy , setFocusTraversalPolicyProvider , setLayout , transferFocusBackward , 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 , getFontMetrics , 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 , processMouseEvent , 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 , transferFocusUpCycle

 

Methods inherited from class java.lang. Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait

 

Field Detail

ui

protected transient ComponentUI ui

The look and feel delegate for this component.

listenerList

protected EventListenerList listenerList

A list of event listeners for this component.

WHEN_FOCUSED

public static final int WHEN_FOCUSED

Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus.

See Also:

Constant Field Values

WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

public static final int WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.

See Also:

Constant Field Values

WHEN_IN_FOCUSED_WINDOW

public static final int WHEN_IN_FOCUSED_WINDOW

Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.

See Also:

Constant Field Values

UNDEFINED_CONDITION

public static final int UNDEFINED_CONDITION

Constant used by some of the APIs to mean that no condition is defined.

See Also:

Constant Field Values

TOOL_TIP_TEXT_KEY

public static final String TOOL_TIP_TEXT_KEY

The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".

See Also:

Constant Field Values

accessibleContext

protected AccessibleContext accessibleContext

The AccessibleContext associated with this JComponent.

JComponent

public JComponent()

Default JComponent constructor. This constructor does very little initialization beyond calling the Container constructor. For example, the initial layout manager is null. It does, however, set the component's locale property to the value returned by JComponent.getDefaultLocale.

See Also:

getDefaultLocale()

setInheritsPopupMenu updateUI

public void setInheritsPopupMenu updateUI (boolean value) () 

Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it. Resets the UI property to a value from the current look and feel. JComponent subclasses must override this method like this:

 public void updateUI() {
 setUI((SliderUI)UIManager.getUI(this);
 }
 

The default value for this is false, but some JComponent subclasses that are implemented as a number of JComponents may set this to true.

This is a bound property.

Parameters:

value - whether or not the JPopupMenu is inherited

Since:

1.5

See Also:

setComponentPopupMenu(javax.swing.JPopupMenu) setUI(javax.swing.plaf.ComponentUI) , UIManager.getLookAndFeel() , UIManager.getUI(javax.swing.JComponent)

getInheritsPopupMenu setUI

public boolean 
protected void getInheritsPopupMenu setUI () ( ComponentUI newUI) 

Returns true if the JPopupMenu should be inherited from the parent. Sets the look and feel delegate for this component. JComponent subclasses generally override this method to narrow the argument type. For example, in JSlider:

 public void setUI(SliderUI newUI) {
 super.setUI(newUI);
 }
 

Additionally JComponent subclasses must provide a getUI method that returns the correct type. For example:

 public SliderUI getUI() {
 return (SliderUI)ui;
 }
 

Since: Parameters:

1.5

newUI - the new UI delegate

See Also:

setComponentPopupMenu(javax.swing.JPopupMenu) updateUI() , UIManager.getLookAndFeel() , UIManager.getUI(javax.swing.JComponent)

setComponentPopupMenu getUIClassID

public void 
public StringsetComponentPopupMenu getUIClassID ( JPopupMenu popup) () 

Sets the JPopupMenu for this JComponent. The UI is responsible for registering bindings and adding the necessary listeners such that the JPopupMenu will be shown at the appropriate time. When the JPopupMenu is shown depends upon the look and feel: some may show it on a mouse event, some may enable a key binding. Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component. Most applications will never need to call this method. Subclasses of JComponent that support pluggable look and feel should override this method to return a UIDefaults key that maps to the ComponentUI subclass that defines their look and feel.

If popup is null, and getInheritsPopupMenu returns true, then getComponentPopupMenu will be delegated to the parent. This provides for a way to make all child components inherit the popupmenu of the parent.

This is a bound property.

Parameters: Returns:

popup - - the popup that will be assigned to this component may be null the UIDefaults key for a ComponentUI subclass

Since:

1.5

See Also:

getComponentPopupMenu() UIDefaults.getUI(javax.swing.JComponent)

getComponentPopupMenu getComponentGraphics

public JPopupMenu
protected GraphicsgetComponentPopupMenu getComponentGraphics () ( Graphics g) 

Returns JPopupMenu that assigned for this component. If this component does not have a JPopupMenu assigned to it and getInheritsPopupMenu is true, this will return getParent().getComponentPopupMenu() (assuming the parent is valid.) Returns the graphics object used to paint this component. If DebugGraphics is turned on we create a new DebugGraphics object if necessary. Otherwise we just configure the specified graphics object's foreground and font.

Returns: Parameters:

JPopupMenu assigned for this component or null if no popup assigned g - the original Graphics object

Since: Returns:

1.5

See Also:

setComponentPopupMenu(javax.swing.JPopupMenu) a Graphics object configured for this component

updateUI paintComponent

public 
protected void updateUI paintComponent () ( Graphics g) 

Resets the UI property to a value from the current look and feel. JComponent subclasses must override this method like this:

 public void updateUI() {
 setUI((SliderUI)UIManager.getUI(this);
 }
 

Calls the UI delegate's paint method, if the UI delegate is non-null. We pass the delegate a copy of the Graphics object to protect the rest of the paint code from irrevocable changes (for example, Graphics.translate).

If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example, you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it. Further, if you do not invoker super's implementation you must honor the opaque property, that is if this component is opaque, you must completely fill in the background in a non-opaque color. If you do not honor the opaque property you will likely see visual artifacts.

Parameters:

g - the Graphics object to protect

See Also:

setUI(javax.swing.plaf.ComponentUI) paint(java.awt.Graphics) , UIManager.getLookAndFeel() ComponentUI , UIManager.getUI(javax.swing.JComponent)

setUI paintChildren

protected void setUI paintChildren ( ComponentUIGraphics newUI)  g) 

Sets the look and feel delegate for this component. JComponent subclasses generally override this method to narrow the argument type. For example, in JSlider:

 public void setUI(SliderUI newUI) {
 super.setUI(newUI);
 }
 

Paints this component's children. If shouldUseBuffer is true, no component ancestor has a buffer and the component children can use a buffer if they have one. Otherwise, one ancestor has a buffer currently in use and children should not use a buffer to paint.

Additionally JComponent subclasses must provide a getUI method that returns the correct type. For example:

 public SliderUI getUI() {
 return (SliderUI)ui;
 }
 

Parameters:

newUI - the new UI delegate g - the Graphics context in which to paint

See Also:

updateUI() paint(java.awt.Graphics) , UIManager.getLookAndFeel() Container.paint(java.awt.Graphics) , UIManager.getUI(javax.swing.JComponent)

getUIClassID paintBorder

public String
protected void getUIClassID paintBorder () ( Graphics g) 

Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component. Most applications will never need to call this method. Subclasses of JComponent that support pluggable look and feel should override this method to return a UIDefaults key that maps to the ComponentUI subclass that defines their look and feel. Paints the component's border.

If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example, you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it.

Returns: Parameters:

the UIDefaults key for a ComponentUI subclass g - the Graphics context in which to paint

See Also:

UIDefaults.getUI(javax.swing.JComponent) paint(java.awt.Graphics) , setBorder(javax.swing.border.Border)

getComponentGraphics update

protected Graphics
public void getComponentGraphics update (Graphics g)

Returns the graphics object used to paint this component. If DebugGraphics is turned on we create a new DebugGraphics object if necessary. Otherwise we just configure the specified graphics object's foreground and font. Calls paint. Doesn't clear the background but see ComponentUI.update, which is called by paintComponent.

Overrides:

update in class Container

Parameters:

g - the original Graphics object context in which to paint

Returns: See Also:

a Graphics object configured for this component paint(java.awt.Graphics) , paintComponent(java.awt.Graphics) , ComponentUI

paintComponent paint

protected 
public void paintComponent paint (Graphics g)

Calls the UI delegate's paint method, if the UI delegate is non-null. We pass the delegate a copy of the Graphics object to protect the rest of the paint code from irrevocable changes (for example, Graphics.translate). Invoked by Swing to draw components. Applications should not invoke paint directly, but should instead use the repaint method to schedule the component for redrawing.

If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example, you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it. Further, if you do not invoker super's implementation you must honor the opaque property, that is if this component is opaque, you must completely fill in the background in a non-opaque color. If you do not honor the opaque property you will likely see visual artifacts. This method actually delegates the work of painting to three protected methods: paintComponent, paintBorder, and paintChildren. They're called in the order listed to ensure that children appear on top of component itself. Generally speaking, the component and its children should not paint in the insets area allocated to the border. Subclasses can just override this method, as always. A subclass that just wants to specialize the UI (look and feel) delegate's paint method should just override paintComponent.

The passed in Graphics object might have a transform other than the identify transform installed on it. In this case, you might get unexpected results if you cumulatively apply another transform.

Overrides:

paint in class Container

Parameters:

g - the Graphics object context in which to protect paint

See Also:

paint(java.awt.Graphics) paintComponent(java.awt.Graphics) , ComponentUI paintBorder(java.awt.Graphics) , paintChildren(java.awt.Graphics) , getComponentGraphics(java.awt.Graphics) , repaint(long, int, int, int, int)

paintChildren printAll

protected 
public void paintChildren printAll (Graphics g)

Paints this component's children. If shouldUseBuffer is true, no component ancestor has a buffer and the component children can use a buffer if they have one. Otherwise, one ancestor has a buffer currently in use and children should not use a buffer to paint. Invoke this method to print the component. This method invokes print on the component.

Overrides:

printAll in class Component

Parameters:

g - the Graphics context in which to paint

See Also:

paint(java.awt.Graphics) print(java.awt.Graphics) , Container.paint(java.awt.Graphics) printComponent(java.awt.Graphics) , printBorder(java.awt.Graphics) , printChildren(java.awt.Graphics)

paintBorder print

protected 
public void paintBorder print (Graphics g)

Paints the component's border. Invoke this method to print the component. This method will result in invocations to printComponent, printBorder and printChildren. It is not recommended that you override this method, instead override one of the previously mentioned methods. This method sets the component's state such that the double buffer will not be used, eg painting will be done directly on the passed in Graphics.

If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example, you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it.

Overrides:

print in class Container

Parameters:

g - the Graphics context in which to paint

See Also:

paint(java.awt.Graphics) printComponent(java.awt.Graphics) , setBorder(javax.swing.border.Border) printBorder(java.awt.Graphics) , printChildren(java.awt.Graphics)

update printComponent

public 
protected void update printComponent (Graphics g)

Calls paint. Doesn't clear the background but see ComponentUI.update, which is called by paintComponent. This is invoked during a printing operation. This is implemented to invoke paintComponent on the component. Override this if you wish to add special painting behavior when printing.

Overrides:

update in class Container

Parameters:

g - the Graphics context in which to paint

Since:

1.3

See Also:

paint(java.awt.Graphics) print(java.awt.Graphics) , paintComponent(java.awt.Graphics) , ComponentUI

paint printChildren

public 
protected void paint printChildren (Graphics g)

Invoked by Swing to draw components. Applications should not invoke paint directly, but should instead use the repaint method to schedule the component for redrawing. Prints this component's children. This is implemented to invoke paintChildren on the component. Override this if you wish to print the children differently than painting.

This method actually delegates the work of painting to three protected methods: paintComponent, paintBorder, and paintChildren. They're called in the order listed to ensure that children appear on top of component itself. Generally speaking, the component and its children should not paint in the insets area allocated to the border. Subclasses can just override this method, as always. A subclass that just wants to specialize the UI (look and feel) delegate's paint method should just override paintComponent.

Overrides:

paint in class Container

Parameters:

g - the Graphics context in which to paint

Since:

1.3

See Also:

paintComponent(java.awt.Graphics) print(java.awt.Graphics) , paintBorder(java.awt.Graphics) , paintChildren(java.awt.Graphics) , getComponentGraphics(java.awt.Graphics) , repaint(long, int, int, int, int)

printAll printBorder

public 
protected void printAll printBorder (Graphics g)

Invoke this method to print the component. This method invokes print on the component. Prints the component's border. This is implemented to invoke paintBorder on the component. Override this if you wish to print the border differently that it is painted.

Overrides:

printAll in class Component

Parameters:

g - the Graphics context in which to paint

Since:

1.3

See Also:

print(java.awt.Graphics) , printComponent(java.awt.Graphics) , printBorder(java.awt.Graphics) , printChildren(java.awt.Graphics)

print isPaintingTile

public void boolean print isPaintingTile ( Graphics g) () 

Invoke this method to print the component. This method will result in invocations to printComponent, printBorder and printChildren. It is not recommended that you override this method, instead override one of the previously mentioned methods. This method sets the component's state such that the double buffer will not be used, eg painting will be done directly on the passed in Graphics. Returns true if the component is currently painting a tile. If this method returns true, paint will be called again for another tile. This method returns false if you are not painting a tile or if the last tile is painted. Use this method to keep some state you might need between tiles.

Overrides:

print in class Container

Parameters: Returns:

g - the Graphics context in which to paint

See Also:

printComponent(java.awt.Graphics) , printBorder(java.awt.Graphics) , printChildren(java.awt.Graphics) true if the component is currently painting a tile, false otherwise

printComponent isManagingFocus

protected void 
public boolean printComponent isManagingFocus ( Graphics g) () 

This is invoked during a printing operation. This is implemented to invoke paintComponent on the component. Override this if you wish to add special painting behavior when printing. Deprecated.   As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean).

Changes this JComponent's focus traversal keys to CTRL+TAB and CTRL+SHIFT+TAB. Also prevents SortingFocusTraversalPolicy from considering descendants of this JComponent when computing a focus traversal cycle.

Parameters:

g - the Graphics context in which to paint

Since:

1.3

See Also:

print(java.awt.Graphics) Component.setFocusTraversalKeys(int, java.util.Set) , SortingFocusTraversalPolicy

printChildren setNextFocusableComponent

protected 
public void printChildren setNextFocusableComponent ( GraphicsComponent g)  aComponent) 

Prints this component's children. This is implemented to invoke paintChildren on the component. Override this if you wish to print the children differently than painting. Deprecated.   As of 1.4, replaced by FocusTraversalPolicy

Overrides the default FocusTraversalPolicy for this JComponent's focus traversal cycle by unconditionally setting the specified Component as the next Component in the cycle, and this JComponent as the specified Component's previous Component in the cycle.

Parameters:

g - the Graphics context in which to paint aComponent - the Component that should follow this JComponent in the focus traversal cycle

Since:

1.3

See Also:

print(java.awt.Graphics) getNextFocusableComponent() , FocusTraversalPolicy

printBorder getNextFocusableComponent

protected void 
public ComponentprintBorder getNextFocusableComponent ( Graphics g) () 

Prints the component's border. This is implemented to invoke paintBorder on the component. Override this if you wish to print the border differently that it is painted. Deprecated.   As of 1.4, replaced by FocusTraversalPolicy.

Returns the Component set by a prior call to setNextFocusableComponent(Component) on this JComponent.

Parameters: Returns:

g - the Graphics context in which to paint the Component that will follow this JComponent in the focus traversal cycle, or null if none has been explicitly specified

Since:

1.3

See Also:

print(java.awt.Graphics) setNextFocusableComponent(java.awt.Component)

isPaintingTile setRequestFocusEnabled

public boolean void isPaintingTile setRequestFocusEnabled () (boolean requestFocusEnabled) 

Returns true if the component is currently painting a tile. If this method returns true, paint will be called again for another tile. This method returns false if you are not painting a tile or if the last tile is painted. Use this method to keep some state you might need between tiles. Provides a hint as to whether or not this JComponent should get focus. This is only a hint, and it is up to consumers that are requesting focus to honor this property. This is typically honored for mouse operations, but not keyboard operations. For example, look and feels could verify this property is true before requesting focus during a mouse operation. This would often times be used if you did not want a mouse press on a JComponent to steal focus, but did want the JComponent to be traversable via the keyboard. If you do not want this JComponent focusable at all, use the setFocusable method instead.

Returns: Parameters:

true if the component is currently painting a tile, false otherwise requestFocusEnabled - Indicates if you want this JComponent to be focusable or not

See Also:

Focus Specification , Component.setFocusable(boolean)

isManagingFocus isRequestFocusEnabled

public boolean isManagingFocus isRequestFocusEnabled ()

Deprecated.   As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean). Returns true if this JComponent should get focus; otherwise returns false.

In release 1.4, the focus subsystem was rearchitected. For more information, see How to Use the Focus Subsystem , a section in The Java Tutorial.

Changes this JComponent's focus traversal keys to CTRL+TAB and CTRL+SHIFT+TAB. Also prevents SortingFocusTraversalPolicy from considering descendants of this JComponent when computing a focus traversal cycle.

Returns:

true if this component should get focus, otherwise returns false

See Also:

Component.setFocusTraversalKeys(int, java.util.Set) setRequestFocusEnabled(boolean) , SortingFocusTraversalPolicy Focus Specification , Component.isFocusable()

setNextFocusableComponent requestFocus

public void setNextFocusableComponent requestFocus ( Component aComponent) () 

Deprecated. Description copied from class: Component   As of 1.4, replaced by FocusTraversalPolicy

Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. This component must be displayable, visible, and focusable for the request to be granted. Every effort will be made to honor the request; however, in some cases it may be impossible to do so. Developers must never assume that this Component is the focus owner until this Component receives a FOCUS_GAINED event. If this request is denied because this Component's top-level Window cannot become the focused Window, the request will be remembered and will be granted when the Window is later focused by the user.

In release 1.4, the focus subsystem was rearchitected. For more information, see How to Use the Focus Subsystem , a section in The Java Tutorial. This method cannot be used to set the focus owner to no Component at all. Use KeyboardFocusManager.clearGlobalFocusOwner() instead.

Overrides the default FocusTraversalPolicy for this JComponent's focus traversal cycle by unconditionally setting the specified Component as the next Component in the cycle, and this JComponent as the specified Component's previous Component in the cycle. Because the focus behavior of this method is platform-dependent, developers are strongly encouraged to use requestFocusInWindow when possible.

Overrides:

requestFocus in class Component

Parameters:

aComponent - the Component that should follow this JComponent in the focus traversal cycle

See Also:

getNextFocusableComponent() Component.requestFocusInWindow() , FocusTraversalPolicy FocusEvent , Component.addFocusListener(java.awt.event.FocusListener) , Component.isFocusable() , Component.isDisplayable() , KeyboardFocusManager.clearGlobalFocusOwner()

getNextFocusableComponent requestFocus

public Component
public boolean getNextFocusableComponent requestFocus () (boolean temporary) 

Deprecated.   As of 1.4, replaced by FocusTraversalPolicy. JComponent overrides requestFocus solely to make the method public so that UI implementations can cause temporary focus changes. This method is not meant for general use, instead developers are urged to call the noarg requestFocus or requestFocusInWindow methods. If the JComponent has an InputVerifierassociated with it, the InputVerifier will be messaged.

In release 1.4, the focus subsystem was rearchitected. For more information, see How to Use the Focus Subsystem Refer to Component.requestFocus(boolean) , a section in The Java Tutorial. for a complete description of this method.

Returns the Component set by a prior call to setNextFocusableComponent(Component) on this JComponent.

Overrides:

requestFocus in class Component

Parameters:

temporary - boolean indicating if the focus change is temporary

Returns:

the Component that will follow this JComponent in the focus traversal cycle, or null if none has been explicitly specified false if the focus change request is guaranteed to fail; true if it is likely to succeed

Since:

1.4

See Also:

setNextFocusableComponent(java.awt.Component) Component.requestFocus() , Component.requestFocusInWindow() , Component.requestFocus(boolean) , Component.requestFocusInWindow(boolean)

setRequestFocusEnabled requestFocusInWindow

public void boolean setRequestFocusEnabled requestFocusInWindow (boolean requestFocusEnabled) () 

Provides a hint as to whether or not this JComponent should get focus. This is only a hint, and it is up to consumers that are requesting focus to honor this property. This is typically honored for mouse operations, but not keyboard operations. For example, look and feels could verify this property is true before requesting focus during a mouse operation. This would often times be used if you did not want a mouse press on a JComponent to steal focus, but did want the JComponent to be traversable via the keyboard. If you do not want this JComponent focusable at all, use the setFocusable method instead. Description copied from class: Component

Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window. This component must be displayable, visible, and focusable for the request to be granted. Every effort will be made to honor the request; however, in some cases it may be impossible to do so. Developers must never assume that this Component is the focus owner until this Component receives a FOCUS_GAINED event.

Please see How to Use the Focus Subsystem , a section in The Java Tutorial, for more information. This method returns a boolean value. If false is returned, the request is guaranteed to fail . If true is returned, the request will succeed unless it is vetoed, or an extraordinary event, such as disposal of the Component's peer, occurs before the request can be granted by the native windowing system. Again, while a return value of true indicates that the request is likely to succeed, developers must never assume that this Component is the focus owner until this Component receives a FOCUS_GAINED event.

This method cannot be used to set the focus owner to no Component at all. Use KeyboardFocusManager.clearGlobalFocusOwner() instead.

The focus behavior of this method can be implemented uniformly across platforms, and thus developers are strongly encouraged to use this method over requestFocus when possible. Code which relies on requestFocus may exhibit different focus behavior on different platforms.

Overrides:

requestFocusInWindow in class Component

Parameters: Returns:

requestFocusEnabled - indicates whether you want this JComponent to be focusable or not false if the focus change request is guaranteed to fail; true if it is likely to succeed

See Also:

Focus Specification Component.requestFocus() , Component.setFocusable(boolean) FocusEvent , Component.addFocusListener(java.awt.event.FocusListener) , Component.isFocusable() , Component.isDisplayable() , KeyboardFocusManager.clearGlobalFocusOwner()

isRequestFocusEnabled requestFocusInWindow

public 
protected boolean isRequestFocusEnabled requestFocusInWindow () (boolean temporary) 

Returns true if this JComponent should get focus; otherwise returns false. JComponent overrides requestFocusInWindow solely to make the method public so that UI implementations can cause temporary focus changes. This method is not meant for general use, instead developers are urged to call the noarg requestFocus or requestFocusInWindow methods. If the JComponent has an InputVerifierassociated with it, the InputVerifier will be messaged.

Please see How to Use the Focus Subsystem Refer to Component.requestFocusInWindow(boolean) , a section in The Java Tutorial, for more information. for a complete description of this method.

Overrides:

requestFocusInWindow in class Component

Parameters:

temporary - boolean indicating if the focus change is temporary

Returns:

true if this component should get focus, otherwise returns false false if the focus change request is guaranteed to fail; true if it is likely to succeed

Since:

1.4

See Also:

setRequestFocusEnabled(boolean) Component.requestFocus() , Focus Specification Component.requestFocusInWindow() , Component.isFocusable() Component.requestFocus(boolean) , Component.requestFocusInWindow(boolean)

requestFocus grabFocus

public void requestFocus grabFocus ()

Requests that this Component gets the input focus. Refer to Component.requestFocus() for a complete description of this method. Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. This component must be displayable, visible, and focusable for the request to be granted.

Note that the use of this method is discouraged because its behavior is platform dependent. Instead we recommend the use of requestFocusInWindow() . If you would like more information on focus, see

Overrides:

requestFocus in class Component This method is intended for use by focus implementations. Client code should not use this method; instead, it should use requestFocus().

Since:

1.4

See Also:

Component.requestFocusInWindow() requestFocus() , Component.requestFocusInWindow(boolean)

---

requestFocus setVerifyInputWhenFocusTarget

public boolean void requestFocus setVerifyInputWhenFocusTarget (boolean temporary) (boolean verifyInputWhenFocusTarget) 

Requests that this Component gets the input focus. Refer to Component.requestFocus(boolean) for a complete description of this method. Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. The default is true. Set to false on components such as a Cancel button or a scrollbar, which should activate even if the input in the current focus owner is not "passed" by the input verifier for that component.

Note that the use of this method is discouraged because its behavior is platform dependent. Instead we recommend the use of requestFocusInWindow(boolean) . If you would like more information on focus, see How to Use the Focus Subsystem , a section in The Java Tutorial.

Overrides:

requestFocus in class Component

Parameters:

temporary - boolean indicating if the focus change is temporary verifyInputWhenFocusTarget - value for the verifyInputWhenFocusTarget property

Returns:

false if the focus change request is guaranteed to fail; true if it is likely to succeed

Since:

1.4 1.3

See Also:

Component.requestFocusInWindow() InputVerifier , Component.requestFocusInWindow(boolean) setInputVerifier(javax.swing.InputVerifier) , getInputVerifier() , getVerifyInputWhenFocusTarget()

---

requestFocusInWindow getVerifyInputWhenFocusTarget

public boolean requestFocusInWindow getVerifyInputWhenFocusTarget ()

Requests that this Component gets the input focus. Refer to Component.requestFocusInWindow() for a complete description of this method. Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.

If you would like more information on focus, see How to Use the Focus Subsystem , a section in The Java Tutorial.

Overrides:

requestFocusInWindow in class Component

Returns:

false if the focus change request is guaranteed to fail; true if it is likely to succeed value of the verifyInputWhenFocusTarget property

Since:

1.4 1.3

See Also:

Component.requestFocusInWindow() InputVerifier , Component.requestFocusInWindow(boolean) setInputVerifier(javax.swing.InputVerifier) , getInputVerifier() , setVerifyInputWhenFocusTarget(boolean)

---

requestFocusInWindow setPreferredSize

protected boolean 
public void requestFocusInWindow setPreferredSize (boolean temporary) ( Dimension preferredSize) 

Requests that this Component gets the input focus. Refer to Component.requestFocusInWindow(boolean) for a complete description of this method. Sets the preferred size of this component. If preferredSize is null, the UI will be asked for the preferred size.

If you would like more information on focus, see

Overrides:

requestFocusInWindow in class Component

Parameters:

temporary - boolean indicating if the focus change is temporary

Returns:

false if the focus change request is guaranteed to fail; true if it is likely to succeed

Since:

1.4

See Also:

Component.requestFocusInWindow() , Component.requestFocusInWindow(boolean)

---

grabFocus getPreferredSize

public void 
public DimensiongrabFocus getPreferredSize ()

Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. This component must be displayable, visible, and focusable for the request to be granted. If the preferredSize has been set to a non-null value just returns it. If the UI delegate's getPreferredSize method returns a non null value then return that; otherwise defer to the component's layout manager.

This method is intended for use by focus implementations. Client code should not use this method; instead, it should use requestFocusInWindow().

Overrides:

getPreferredSize in class Container

Returns:

the value of the preferredSize property

See Also:

requestFocusInWindow() setPreferredSize(java.awt.Dimension) , ComponentUI

---

setVerifyInputWhenFocusTarget setMaximumSize

public void setVerifyInputWhenFocusTarget setMaximumSize (boolean verifyInputWhenFocusTarget) ( Dimension maximumSize) 

Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. The default is true. Set to false on components such as a Cancel button or a scrollbar, which should activate even if the input in the current focus owner is not "passed" by the input verifier for that component. Sets the maximum size of this component to a constant value. Subsequent calls to getMaximumSize will always return this value; the component's UI will not be asked to compute it. Setting the maximum size to null restores the default behavior.

Parameters:

verifyInputWhenFocusTarget - value for the verifyInputWhenFocusTarget property maximumSize - a Dimension containing the desired maximum allowable size

Since:

1.3

See Also:

InputVerifier getMaximumSize() , setInputVerifier(javax.swing.InputVerifier) , getInputVerifier() , getVerifyInputWhenFocusTarget()

---

getVerifyInputWhenFocusTarget getMaximumSize

public boolean 
public DimensiongetVerifyInputWhenFocusTarget getMaximumSize ()

Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus. If the maximum size has been set to a non-null value just returns it. If the UI delegate's getMaximumSize method returns a non-null value then return that; otherwise defer to the component's layout manager.

Overrides:

getMaximumSize in class Container

Returns:

the value of the verifyInputWhenFocusTarget maximumSize property

Since:

1.3

See Also:

InputVerifier setMaximumSize(java.awt.Dimension) , setInputVerifier(javax.swing.InputVerifier) ComponentUI , getInputVerifier() , setVerifyInputWhenFocusTarget(boolean)

---

getFontMetrics setMinimumSize

public FontMetrics
public void getFontMetrics setMinimumSize ( FontDimension font)  minimumSize) 

Gets the FontMetrics for the specified Font. Sets the minimum size of this component to a constant value. Subsequent calls to getMinimumSize will always return this value; the component's UI will not be asked to compute it. Setting the minimum size to null restores the default behavior.

Overrides:

getFontMetrics in class Component

Parameters:

font - the font for which font metrics is to be obtained minimumSize - the new minimum size of this component

Returns:

the font metrics for font

Throws:

NullPointerException - if font is null

Since:

1.5

See Also:

Component.getFont() getMinimumSize() , Component.getPeer() , ComponentPeer.getFontMetrics(Font), Toolkit.getFontMetrics(Font)

---

setPreferredSize getMinimumSize

public void 
public DimensionsetPreferredSize getMinimumSize ( Dimension preferredSize) () 

Sets the preferred size of this component. If preferredSize is null, the UI will be asked for the preferred size. If the minimum size has been set to a non-null value just returns it. If the UI delegate's getMinimumSize method returns a non-null value then return that; otherwise defer to the component's layout manager.

Overrides:

setPreferredSize getMinimumSize in class Component Container

Parameters: Returns:

preferredSize - The new preferred size, or null the value of the minimumSize property

See Also:

Component.getPreferredSize() setMinimumSize(java.awt.Dimension) , Component.isPreferredSizeSet() ComponentUI

---

getPreferredSize isMinimumSizeSet

public Dimension
public boolean getPreferredSize isMinimumSizeSet ()

If the preferredSize has been set to a non-null value just returns it. If the UI delegate's getPreferredSize method returns a non null value then return that; otherwise defer to the component's layout manager. Returns true if the minimum size has been set to a non-null value otherwise returns false.

Overrides:

getPreferredSize in class Container

Returns:

the value of the preferredSize property true if minimumSize is non-null, false otherwise

See Also: Since:

setPreferredSize(java.awt.Dimension) , ComponentUI 1.3

---

setMaximumSize isPreferredSizeSet

public void boolean setMaximumSize isPreferredSizeSet ( Dimension maximumSize) () 

Sets the maximum size of this component to a constant value. Subsequent calls to getMaximumSize will always return this value; the component's UI will not be asked to compute it. Setting the maximum size to null restores the default behavior. Returns true if the preferred size has been set to a non-null value otherwise returns false.

Overrides:

setMaximumSize in class Component

Parameters: Returns:

maximumSize - a Dimension containing the desired maximum allowable size true if preferredSize is non-null, false otherwise

See Also: Since:

getMaximumSize() 1.3

---

getMaximumSize isMaximumSizeSet

public Dimension
public boolean getMaximumSize isMaximumSizeSet ()

If the maximum size has been set to a non-null value just returns it. If the UI delegate's getMaximumSize method returns a non-null value then return that; otherwise defer to the component's layout manager. Returns true if the maximum size has been set to a non-null value otherwise returns false.

Overrides:

getMaximumSize in class Container

Returns:

the value of the maximumSize property true if maximumSize is non-null, false otherwise

See Also: Since:

setMaximumSize(java.awt.Dimension) , ComponentUI 1.3

---

setMinimumSize contains

public void boolean setMinimumSize contains ( Dimension minimumSize) (int x,
 int y) 

Sets the minimum size of this component to a constant value. Subsequent calls to getMinimumSize will always return this value; the component's UI will not be asked to compute it. Setting the minimum size to null restores the default behavior. Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.

Overrides:

setMinimumSize contains in class Component

Parameters:

minimumSize - the new minimum size of this component x - the x coordinate of the point

y - the y coordinate of the point

Returns:

true if this component logically contains x,y

See Also:

getMinimumSize() Component.contains(int, int) , ComponentUI

---

getMinimumSize setBorder

public Dimension
public void getMinimumSize setBorder () ( Border border) 

If the minimum size has been set to a non-null value just returns it. If the UI delegate's getMinimumSize method returns a non-null value then return that; otherwise defer to the component's layout manager. Sets the border of this component. The Border object is responsible for defining the insets for the component (overriding any insets set directly on the component) and for optionally rendering any border decorations within the bounds of those insets. Borders should be used (rather than insets) for creating both decorative and non-decorative (such as margins and padding) regions for a swing component. Compound borders can be used to nest multiple borders within a single component.

This is a bound property.

Overrides:

getMinimumSize in class Container

Returns: Parameters:

the value of the minimumSize property border - the border to be rendered for this component

See Also:

setMinimumSize(java.awt.Dimension) Border , ComponentUI CompoundBorder

---

contains getBorder

public boolean 
public Bordercontains getBorder (int x,
 int y) () 

Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing. Returns the border of this component or null if no border is currently set.

Overrides:

contains in class Component

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

Returns:

true if this component logically contains x,y the border object for this component

See Also:

Component.contains(int, int) setBorder(javax.swing.border.Border) , ComponentUI

---

setBorder getInsets

public void 
public InsetssetBorder getInsets ( Border border) () 

Sets the border of this component. The Border object is responsible for defining the insets for the component (overriding any insets set directly on the component) and for optionally rendering any border decorations within the bounds of those insets. Borders should be used (rather than insets) for creating both decorative and non-decorative (such as margins and padding) regions for a swing component. Compound borders can be used to nest multiple borders within a single component. If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets.

Although technically you can set the border on any object that inherits from JComponent , the look and feel implementation of many standard Swing components doesn't work well with user-set borders. In general, when you want to set a border on a standard Swing component other than JPanel or JLabel, we recommend that you put the component in a JPanel and set the border on the JPanel.

This is a bound property.

Overrides:

getInsets in class Container

Parameters: Returns:

border - the border to be rendered for this component the value of the insets property

See Also:

Border setBorder(javax.swing.border.Border) , CompoundBorder

---

getBorder getInsets

public BorderInsetsgetBorder getInsets () ( Insets insets) 

Returns the border of this component or null if no border is currently set. Returns an Insets object containing this component's inset values. The passed-in Insets object will be reused if possible. Calling methods cannot assume that the same object will be returned, however. All existing values within this object are overwritten. If insets is null, this will allocate a new one.

Parameters:

insets - the Insets object, which can be reused

Returns:

the border object for this component the Insets object

See Also:

setBorder(javax.swing.border.Border) getInsets()

---

getInsets getAlignmentY

public Insets
public float getInsets getAlignmentY ()

If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets. Overrides Container.getAlignmentY to return the horizontal alignment.

Overrides:

getInsets getAlignmentY in class Container

Returns:

the value of the insets alignmentY property

See Also:

setBorder(javax.swing.border.Border) setAlignmentY(float) , Component.getAlignmentY()

---

getInsets setAlignmentY

public Insets
public void getInsets setAlignmentY ( Insets insets) (float alignmentY) 

Returns an Insets object containing this component's inset values. The passed-in Insets object will be reused if possible. Calling methods cannot assume that the same object will be returned, however. All existing values within this object are overwritten. If insets is null, this will allocate a new one. Sets the the horizontal alignment.

Parameters:

insets - the Insets object, which can be reused alignmentY - the new horizontal alignment

Returns:

the Insets object

See Also:

getInsets() getAlignmentY()

---

getAlignmentY getAlignmentX

public float getAlignmentY getAlignmentX ()

Overrides Container.getAlignmentY Container.getAlignmentX to return the horizontal vertical alignment.

Overrides:

getAlignmentY getAlignmentX in class Container

Returns:

the value of the alignmentY alignmentX property

See Also:

setAlignmentY(float) setAlignmentX(float) , Component.getAlignmentY() Component.getAlignmentX()

---

setAlignmentY setAlignmentX

public void setAlignmentY setAlignmentX (float alignmentY) (float alignmentX) 

Sets the the horizontal vertical alignment.

Parameters:

alignmentY alignmentX - the new horizontal vertical alignment

See Also:

getAlignmentY() getAlignmentX()

---

getAlignmentX setInputVerifier

public float void getAlignmentX setInputVerifier () ( InputVerifier inputVerifier) 

Overrides Container.getAlignmentX to return the vertical alignment. Sets the input verifier for this component.

Overrides: Parameters:

getAlignmentX in class Container

inputVerifier - the new input verifier

Returns: Since:

the value of the alignmentX property 1.3

See Also:

setAlignmentX(float) InputVerifier , Component.getAlignmentX()

---

setAlignmentX getInputVerifier

public void 
public InputVerifiersetAlignmentX getInputVerifier (float alignmentX) () 

Sets the the vertical alignment. Returns the input verifier for this component.

Parameters: Returns:

alignmentX - the new vertical alignment the inputVerifier property

Since:

1.3

See Also:

getAlignmentX() InputVerifier

---

setInputVerifier getGraphics

public void 
public GraphicssetInputVerifier getGraphics ( InputVerifier inputVerifier) () 

Sets the input verifier for this component. Returns this component's graphics context, which lets you draw on a component. Use this method get a Graphics object and then invoke operations on that object to draw on the component.

Overrides:

getGraphics in class Component

Parameters: Returns:

inputVerifier - the new input verifier this components graphics context

Since:

1.3

See Also:

InputVerifier Component.paint(java.awt.Graphics)

---

getInputVerifier setDebugGraphicsOptions

public InputVerifier
public void getInputVerifier setDebugGraphicsOptions () (int debugOptions) 

Returns the input verifier for this component. Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.

Returns: Parameters:

the inputVerifier property

Since:

1.3

See Also:

InputVerifier debugOptions - determines how the component should display the information; one of the following options:

• DebugGraphics.LOG_OPTION - causes a text message to be printed.
• DebugGraphics.FLASH_OPTION - causes the drawing to flash several times.
• DebugGraphics.BUFFERED_OPTION - creates an ExternalWindow that displays the operations performed on the View's offscreen buffer.
• DebugGraphics.NONE_OPTION disables debugging.
• A value of 0 causes no changes to the debugging options.

debugOptions is bitwise OR'd into the current value

---

getGraphics getDebugGraphicsOptions

public Graphics
public int getGraphics getDebugGraphicsOptions ()

Returns this component's graphics context, which lets you draw on a component. Use this method get a Graphics object and then invoke operations on that object to draw on the component. Returns the state of graphics debugging.

Overrides:

getGraphics in class Component

Returns:

this components graphics context a bitwise OR'd flag of zero or more of the following options:

• DebugGraphics.LOG_OPTION - causes a text message to be printed.
• DebugGraphics.FLASH_OPTION - causes the drawing to flash several times.
• DebugGraphics.BUFFERED_OPTION - creates an ExternalWindow that displays the operations performed on the View's offscreen buffer.
• DebugGraphics.NONE_OPTION disables debugging.
• A value of 0 causes no changes to the debugging options.

See Also:

Component.paint(java.awt.Graphics) setDebugGraphicsOptions(int)

---

setDebugGraphicsOptions registerKeyboardAction

public void setDebugGraphicsOptions registerKeyboardAction (int debugOptions) ( ActionListener anAction,
 String aCommand,
 KeyStroke aKeyStroke,
 int aCondition) 

Enables or disables diagnostic information about every graphics operation performed within the component or one of its children. This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior. For example, to bind the KeyStroke aKeyStroke to the Action anAction now use:

 component.getInputMap().put(aKeyStroke, aCommand);
 component.getActionMap().put(aCommmand, anAction);
 

The above assumes you want the binding to be applicable for WHEN_FOCUSED. To register bindings for other focus states use the getInputMap method that takes an integer.

Register a new keyboard action. anAction will be invoked if a key event matching aKeyStroke occurs and aCondition is verified. The KeyStroke object defines a particular combination of a keyboard key and one or more modifiers (alt, shift, ctrl, meta).

The aCommand will be set in the delivered event if specified.

The aCondition can be one of:

WHEN_FOCUSED

The action will be invoked only when the keystroke occurs while the component has the focus.

WHEN_IN_FOCUSED_WINDOW

The action will be invoked when the keystroke occurs while the component has the focus or if the component is in the window that has the focus. Note that the component need not be an immediate descendent of the window -- it can be anywhere in the window's containment hierarchy. In other words, whenever any component in the window has the focus, the action registered with this component is invoked.

WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

The action will be invoked when the keystroke occurs while the component has the focus or if the component is an ancestor of the component that has the focus.

The combination of keystrokes and conditions lets you define high level (semantic) action events for a specified keystroke+modifier combination (using the KeyStroke class) and direct to a parent or child of a component that has the focus, or to the component itself. In other words, in any hierarchical structure of components, an arbitrary key-combination can be immediately directed to the appropriate component in the hierarchy, and cause a specific method to be invoked (usually by way of adapter objects).

If an action has already been registered for the receiving container, with the same charCode and the same modifiers, anAction will replace the action.

Parameters:

debugOptions - determines how the component should display the information; one of the following options:

• DebugGraphics.LOG_OPTION - causes a text message to be printed.
• DebugGraphics.FLASH_OPTION - causes the drawing to flash several times.
• DebugGraphics.BUFFERED_OPTION - creates an ExternalWindow that displays the operations performed on the View's offscreen buffer.
• DebugGraphics.NONE_OPTION disables debugging.
• A value of 0 causes no changes to the debugging options.

debugOptions is bitwise OR'd into the current value anAction - the Action to be registered

aCommand - the command to be set in the delivered event

aKeyStroke - the KeyStroke to bind to the action

aCondition - the condition that needs to be met, see above

See Also:

KeyStroke

---

getDebugGraphicsOptions registerKeyboardAction

public int void getDebugGraphicsOptions registerKeyboardAction () ( ActionListener anAction,
 KeyStroke aKeyStroke,
 int aCondition) 

Returns the state of graphics debugging. This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior.

Returns:

a bitwise OR'd flag of zero or more of the following options:

• DebugGraphics.LOG_OPTION - causes a text message to be printed.
• DebugGraphics.FLASH_OPTION - causes the drawing to flash several times.
• DebugGraphics.BUFFERED_OPTION - creates an ExternalWindow that displays the operations performed on the View's offscreen buffer.
• DebugGraphics.NONE_OPTION disables debugging.
• A value of 0 causes no changes to the debugging options.

See Also:

setDebugGraphicsOptions(int)

---

registerKeyboardAction unregisterKeyboardAction

public void registerKeyboardAction unregisterKeyboardAction ( ActionListenerKeyStroke anAction,
 String aCommand,
 KeyStroke aKeyStroke,
 int aCondition)  aKeyStroke) 

This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior. For example, to bind the KeyStroke aKeyStroke to the Action anAction now use:

 component.getInputMap().put(aKeyStroke, aCommand);
 component.getActionMap().put(aCommmand, anAction);
 

The above assumes you want the binding to be applicable for WHEN_FOCUSED. To register bindings for other focus states use the getInputMap method that takes an integer. This method is now obsolete. To unregister an existing binding you can either remove the binding from the ActionMap/InputMap, or place a dummy binding the InputMap. Removing the binding from the InputMap allows bindings in parent InputMaps to be active, whereas putting a dummy binding in the InputMap effectively disables the binding from ever happening.

Register a new keyboard action. anAction will be invoked if a key event matching aKeyStroke occurs and aCondition is verified. The KeyStroke object defines a particular combination of a keyboard key and one or more modifiers (alt, shift, ctrl, meta). Unregisters a keyboard action. This will remove the binding from the ActionMap (if it exists) as well as the InputMaps.

The aCommand will be set in the delivered event if specified.

The aCondition can be one of:

WHEN_FOCUSED

The action will be invoked only when the keystroke occurs while the component has the focus.

WHEN_IN_FOCUSED_WINDOW

The action will be invoked when the keystroke occurs while the component has the focus or if the component is in the window that has the focus. Note that the component need not be an immediate descendent of the window -- it can be anywhere in the window's containment hierarchy. In other words, whenever any component in the window has the focus, the action registered with this component is invoked.

WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

The action will be invoked when the keystroke occurs while the component has the focus or if the component is an ancestor of the component that has the focus.

The combination of keystrokes and conditions lets you define high level (semantic) action events for a specified keystroke+modifier combination (using the KeyStroke class) and direct to a parent or child of a component that has the focus, or to the component itself. In other words, in any hierarchical structure of components, an arbitrary key-combination can be immediately directed to the appropriate component in the hierarchy, and cause a specific method to be invoked (usually by way of adapter objects).

If an action has already been registered for the receiving container, with the same charCode and the same modifiers, anAction will replace the action.

Parameters:

anAction - the Action to be registered

aCommand - the command to be set in the delivered event

aKeyStroke - the KeyStroke to bind to the action

aCondition - the condition that needs to be met, see above

See Also:

KeyStroke

---

registerKeyboardAction getRegisteredKeyStrokes

public void 
public KeyStroke[] registerKeyboardAction getRegisteredKeyStrokes ( ActionListener anAction,
 KeyStroke aKeyStroke,
 int aCondition) () 

This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior. Returns the KeyStrokes that will initiate registered actions.

Returns:

an array of KeyStroke objects

See Also:

registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

---

unregisterKeyboardAction getConditionForKeyStroke

public void int unregisterKeyboardAction getConditionForKeyStroke (KeyStroke aKeyStroke)

This method is now obsolete. To unregister an existing binding you can either remove the binding from the ActionMap/InputMap, or place a dummy binding the InputMap. Removing the binding from the InputMap allows bindings in parent InputMaps to be active, whereas putting a dummy binding in the InputMap effectively disables the binding from ever happening. Returns the condition that determines whether a registered action occurs in response to the specified keystroke.

Unregisters a keyboard action. This will remove the binding from the ActionMap (if it exists) as well as the InputMaps. For Java 2 platform v1.3, a KeyStroke can be associated with more than one condition. For example, 'a' could be bound for the two conditions WHEN_FOCUSED and WHEN_IN_FOCUSED_WINDOW condition.

Returns:

the action-keystroke condition

---

getRegisteredKeyStrokes getActionForKeyStroke

public KeyStrokeActionListener[] getRegisteredKeyStrokes getActionForKeyStroke () ( KeyStroke aKeyStroke) 

Returns the KeyStrokes that will initiate registered actions. Returns the object that will perform the action registered for a given keystroke.

Returns:

an array of KeyStroke objects

See Also:

registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int) the ActionListener object invoked when the keystroke occurs

---

getConditionForKeyStroke resetKeyboardActions

public int void getConditionForKeyStroke resetKeyboardActions ( KeyStroke aKeyStroke) () 

Returns the condition that determines whether a registered action occurs in response to the specified keystroke. Unregisters all the bindings in the first tier InputMaps and ActionMap. This has the effect of removing any local bindings, and allowing the bindings defined in parent InputMap/ActionMaps (the UI is usually defined in the second tier) to persist.

For Java 2 platform v1.3, a KeyStroke can be associated with more than one condition. For example, 'a' could be bound for the two conditions WHEN_FOCUSED and WHEN_IN_FOCUSED_WINDOW condition.

Returns:

the action-keystroke condition

---

getActionForKeyStroke setInputMap

public ActionListener
public final void getActionForKeyStroke setInputMap ( KeyStroke(int condition,
 InputMap aKeyStroke)  map) 

Returns the object that will perform the action registered for a given keystroke. Sets the InputMap to use under the condition condition to map. A null value implies you do not want any bindings to be used, even from the UI. This will not reinstall the UI InputMap (if there was one). condition has one of the following values:

• WHEN_IN_FOCUSED_WINDOW
• WHEN_FOCUSED
• WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

If condition is WHEN_IN_FOCUSED_WINDOW and map is not a ComponentInputMap, an IllegalArgumentException will be thrown. Similarly, if condition is not one of the values listed, an IllegalArgumentException will be thrown.

Returns: Parameters:

the ActionListener object invoked when the keystroke occurs condition - one of the values listed above

map - the InputMap to use for the given condition

Throws:

IllegalArgumentException - if condition is WHEN_IN_FOCUSED_WINDOW and map is not an instance of ComponentInputMap; or if condition is not one of the legal values specified above

Since:

1.3

---

resetKeyboardActions getInputMap

public void 
public final InputMapresetKeyboardActions getInputMap () (int condition) 

Unregisters all the bindings in the first tier InputMaps and ActionMap. This has the effect of removing any local bindings, and allowing the bindings defined in parent InputMap/ActionMaps (the UI is usually defined in the second tier) to persist. Returns the InputMap that is used during condition.

Parameters:

condition - one of WHEN_IN_FOCUSED_WINDOW, WHEN_FOCUSED, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

Returns:

the InputMap for the specified condition

Since:

1.3

---

setInputMap getInputMap

public final void InputMapsetInputMap getInputMap (int condition,
 InputMap map) () 

Sets the InputMap to use under the condition condition to map. A null value implies you do not want any bindings to be used, even from the UI. This will not reinstall the UI InputMap (if there was one). condition has one of the following values:

• WHEN_IN_FOCUSED_WINDOW
• WHEN_FOCUSED
• WHEN_ANCESTOR_OF_FOCUSED_COMPONENT

If condition is WHEN_IN_FOCUSED_WINDOW and map is not a ComponentInputMap, an IllegalArgumentException will be thrown. Similarly, if condition is not one of the values listed, an IllegalArgumentException will be thrown. Returns the InputMap that is used when the component has focus. This is convenience method for getInputMap(WHEN_FOCUSED).

Parameters: Returns:

condition - one of the values listed above

map - the InputMap to use for the given condition the InputMap used when the component has focus

Throws:

IllegalArgumentException - if condition is WHEN_IN_FOCUSED_WINDOW and map is not an instance of ComponentInputMap; or if condition is not one of the legal values specified above

Since:

1.3 JDK1.3

---

getInputMap setActionMap

public final InputMapvoid getInputMap setActionMap (int condition) ( ActionMap am) 

Returns the InputMap that is used during condition. Sets the ActionMap to am. This does not set the parent of the am to be the ActionMap from the UI (if there was one), it is up to the caller to have done this.

Parameters:

condition - one of WHEN_IN_FOCUSED_WINDOW, WHEN_FOCUSED, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT am - the new ActionMap

Returns:

the InputMap for the specified condition

Since:

1.3

---

getInputMap getActionMap

public final InputMapActionMapgetInputMap getActionMap ()

Returns the InputMap that is used when the component has focus. This is convenience method for getInputMap(WHEN_FOCUSED). Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding. The returned ActionMap, unless otherwise set, will have the ActionMap from the UI set as the parent.

Returns:

the InputMap used when the component has focus the ActionMap containing the key/action bindings

Since:

JDK1.3 1.3

---

setActionMap requestDefaultFocus

public final void 
public boolean setActionMap requestDefaultFocus ( ActionMap am) () 

Sets the ActionMap to am. This does not set the parent of the am to be the ActionMap from the UI (if there was one), it is up to the caller to have done this. Deprecated.   As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()

Requests focus on this JComponent's FocusTraversalPolicy's default Component. If this JComponent is a focus cycle root, then its FocusTraversalPolicy is used. Otherwise, the FocusTraversalPolicy of this JComponent's focus-cycle-root ancestor is used.

Parameters: See Also:

am - the new ActionMap

Since:

1.3

FocusTraversalPolicy.getDefaultComponent(java.awt.Container)

---

getActionMap setVisible

public final ActionMap
public void getActionMap setVisible () (boolean aFlag) 

Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding. The returned ActionMap, unless otherwise set, will have the ActionMap from the UI set as the parent. Makes the component visible or invisible. Overrides Component.setVisible.

Overrides:

setVisible in class Component

Returns: Parameters:

the ActionMap containing the key/action bindings aFlag - true to make the component visible; false to make it invisible

Since: See Also:

1.3

Component.isVisible()

---

requestDefaultFocus setEnabled

public boolean void requestDefaultFocus setEnabled () (boolean enabled) 

Deprecated.   As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus() Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input.

In release 1.4, the focus subsystem was rearchitected. For more information, see How to Use the Focus Subsystem , a section in The Java Tutorial. Note: Disabling a component does not disable it's children.

Requests focus on this JComponent's FocusTraversalPolicy's default Component. If this JComponent is a focus cycle root, then its FocusTraversalPolicy is used. Otherwise, the FocusTraversalPolicy of this JComponent's focus-cycle-root ancestor is used. Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.

Overrides:

setEnabled in class Component

Parameters:

enabled - true if this component should be enabled, false otherwise

See Also:

FocusTraversalPolicy.getDefaultComponent(java.awt.Container) Component.isEnabled() , Component.isLightweight()

---

setVisible setForeground

public void setVisible setForeground (boolean aFlag) ( Color fg) 

Makes the component visible or invisible. Overrides Component.setVisible. Sets the foreground color of this component.

Overrides:

setVisible setForeground in class Component

Parameters:

aFlag - true to make the component visible; false to make it invisible fg - the desired foreground Color

See Also:

Component.isVisible() Component.getForeground()

---

setEnabled setBackground

public void setEnabled setBackground (boolean enabled) ( Color bg) 

Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input. Sets the background color of this component.

Note: Disabling a component does not disable it's children.

Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.

Overrides:

setEnabled setBackground in class Component

Parameters:

enabled - true if this component should be enabled, false otherwise bg - the desired background Color

See Also:

Component.isEnabled() Component.getBackground() , Component.isLightweight()

---

setForeground setFont

public void setForeground setFont ( ColorFont fg)  font) 

Sets the foreground color of font for this component.

Overrides:

setForeground setFont in class Component Container

Parameters:

fg - the desired foreground Color font - the desired Font for this component

See Also:

Component.getForeground() Component.getFont()

---

setBackground getDefaultLocale

public void 
public static LocalesetBackground getDefaultLocale ( Color bg) () 

Sets the background color of this component. Returns the default locale used to initialize each JComponent's locale property upon creation. The default locale has "AppContext" scope so that applets (and potentially multiple lightweight applications running in a single VM) can have their own setting. An applet can safely alter its default locale because it will have no affect on other applets (or the browser).

Overrides: Returns:

setBackground in class Component

the default Locale.

Parameters: Since:

bg - the desired background Color 1.4

See Also:

Component.getBackground() setDefaultLocale(java.util.Locale) , Component.getLocale() , Component.setLocale(java.util.Locale)

---

setFont setDefaultLocale

public static void setFont setDefaultLocale ( FontLocale font)  l) 

Sets the font for this component. Sets the default locale used to initialize each JComponent's locale property upon creation. The initial value is the VM's default locale. The default locale has "AppContext" scope so that applets (and potentially multiple lightweight applications running in a single VM) can have their own setting. An applet can safely alter its default locale because it will have no affect on other applets (or the browser).

Overrides:

setFont in class Container

Parameters:

font - the desired Font for this component l - the desired default Locale for new components.

Since:

1.4

See Also:

Component.getFont() getDefaultLocale() , Component.getLocale() , Component.setLocale(java.util.Locale)

---

getDefaultLocale processComponentKeyEvent

public static Locale
protected void getDefaultLocale processComponentKeyEvent () ( KeyEvent e) 

Returns the default locale used to initialize each JComponent's locale property upon creation. The default locale has "AppContext" scope so that applets (and potentially multiple lightweight applications running in a single VM) can have their own setting. An applet can safely alter its default locale because it will have no affect on other applets (or the browser). Processes any key events that the component itself recognizes. This is called after the focus manager and any interested listeners have been given a chance to steal away the event. This method is called only if the event has not yet been consumed. This method is called prior to the keyboard UI logic.

This method is implemented to do nothing. Subclasses would normally override this method if they process some key events themselves. If the event is processed, it should be consumed.

Returns:

the default Locale.

Since:

1.4

See Also:

setDefaultLocale(java.util.Locale) , Component.getLocale() , Component.setLocale(java.util.Locale)

---

setDefaultLocale processKeyEvent

public static void 
protected void setDefaultLocale processKeyEvent ( LocaleKeyEvent l)  e) 

Sets the default locale used to initialize each JComponent's locale property upon creation. The initial value is the VM's default locale. The default locale has "AppContext" scope so that applets (and potentially multiple lightweight applications running in a single VM) can have their own setting. An applet can safely alter its default locale because it will have no affect on other applets (or the browser). Overrides processKeyEvent to process events.

Overrides:

processKeyEvent in class Component

Parameters:

l - the desired default Locale for new components. e - the key event

Since:

1.4

See Also:

getDefaultLocale() KeyEvent , Component.getLocale() KeyListener , Component.setLocale(java.util.Locale) Component.addKeyListener(java.awt.event.KeyListener) , Component.enableEvents(long) , Component.isShowing()

---

processComponentKeyEvent processKeyBinding

protected void boolean processComponentKeyEvent processKeyBinding ( KeyEventKeyStroke e)  ks,
 KeyEvent e,
 int condition,
 boolean pressed) 

Processes any key events that the component itself recognizes. This is called after the focus manager and any interested listeners have been given a chance to steal away the event. This method is called only if the event has not yet been consumed. This method is called prior to the keyboard UI logic. Invoked to process the key bindings for ks as the result of the KeyEvent e. This obtains the appropriate InputMap, gets the binding, gets the action from the ActionMap, and then (if the action is found and the component is enabled) invokes notifyAction to notify the action.

This method is implemented to do nothing. Subclasses would normally override this method if they process some key events themselves. If the event is processed, it should be consumed.

Parameters:

ks - the KeyStroke queried

e - the KeyEvent

condition - one of the following values:

• JComponent.WHEN_FOCUSED
• JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
• JComponent.WHEN_IN_FOCUSED_WINDOW

pressed - true if the key is pressed

Returns:

true if there was a binding to an action, and the action was enabled

Since:

1.3

---

processKeyEvent setToolTipText

protected 
public void processKeyEvent setToolTipText ( KeyEventString e)  text) 

Overrides processKeyEvent to process events. Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.

See How to Use Tool Tips in The Java Tutorial for further documentation.

Overrides:

processKeyEvent in class Component

Parameters:

e - the key event text - the string to display; if the text is null, the tool tip is turned off for this component

See Also:

KeyEvent TOOL_TIP_TEXT_KEY , KeyListener , KeyboardFocusManager , DefaultKeyboardFocusManager , Component.processEvent(java.awt.AWTEvent) , Component.dispatchEvent(java.awt.AWTEvent) , Component.addKeyListener(java.awt.event.KeyListener) , Component.enableEvents(long) , Component.isShowing()

---

processKeyBinding getToolTipText

protected boolean 
public StringprocessKeyBinding getToolTipText ( KeyStroke ks,
 KeyEvent e,
 int condition,
 boolean pressed) () 

Invoked to process the key bindings for ks as the result of the KeyEvent e. This obtains the appropriate InputMap, gets the binding, gets the action from the ActionMap, and then (if the action is found and the component is enabled) invokes notifyAction to notify the action. Returns the tooltip string that has been set with setToolTipText.

Parameters:

ks - the KeyStroke queried

e - the KeyEvent

condition - one of the following values:

• JComponent.WHEN_FOCUSED
• JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
• JComponent.WHEN_IN_FOCUSED_WINDOW

pressed - true if the key is pressed

Returns:

true if there was a binding to an action, and the action was enabled the text of the tool tip

Since: See Also:

1.3

TOOL_TIP_TEXT_KEY

---

setToolTipText getToolTipText

public void 
public StringsetToolTipText getToolTipText ( StringMouseEvent text)  event) 

Registers the text to display in a tool tip. The text displays when the cursor lingers over the component. Returns the string to be used as the tooltip for event . By default this returns any string set using setToolTipText. If a component provides more extensive API to support differing tooltips at different locations, this method should be overridden.

See How to Use Tool Tips in The Java Tutorial for further documentation.

Parameters:

text - the string to display; if the text is null, the tool tip is turned off for this component

See Also:

TOOL_TIP_TEXT_KEY

---

getToolTipText getToolTipLocation

public StringPointgetToolTipText getToolTipLocation () ( MouseEvent event) 

Returns the tooltip string that has been set with setToolTipText. Returns the tooltip location in this component's coordinate system. If null is returned, Swing will choose a location. The default implementation returns null.

Returns: Parameters:

the text of the tool tip event - the MouseEvent that caused the ToolTipManager to show the tooltip

See Also: Returns:

TOOL_TIP_TEXT_KEY always returns null

---

getToolTipText createToolTip

public StringJToolTipgetToolTipText createToolTip ( MouseEvent event) () 

Returns the string to be used as the tooltip for event . By default this returns any string set using setToolTipText. If a component provides more extensive API to support differing tooltips at different locations, this method should be overridden. Returns the instance of JToolTip that should be used to display the tooltip. Components typically would not override this method, but it can be used to cause different tooltips to be displayed differently.

Returns:

the JToolTip used to display this toolTip

---

getToolTipLocation scrollRectToVisible

public Point
public void getToolTipLocation scrollRectToVisible ( MouseEventRectangle event)  aRect) 

Returns the tooltip location in this component's coordinate system. If null is returned, Swing will choose a location. The default implementation returns null. Forwards the scrollRectToVisible() message to the JComponent's parent. Components that can service the request, such as JViewport, override this method and perform the scrolling.

Parameters:

event - the MouseEvent that caused the ToolTipManager to show the tooltip aRect - the visible Rectangle

Returns: See Also:

always returns null JViewport

---

getPopupLocation setAutoscrolls

public Point
public void getPopupLocation setAutoscrolls ( MouseEvent event) (boolean autoscrolls) 

Returns the preferred location to display the popup menu in this component's coordinate system. It is up to the look and feel to honor this propery, some may choose to ignore it. If null is truend the look and feel will choose a suitable location. Sets the autoscrolls property. If true mouse dragged events will be synthetically generated when the mouse is dragged outside of the component's bounds and mouse motion has paused (while the button continues to be held down). The synthetic events make it appear that the drag gesture has resumed in the direction established when the component's boundary was crossed. Components that support autoscrolling must handle mouseDragged events by calling scrollRectToVisible with a rectangle that contains the mouse event's location. All of the Swing components that support item selection and are typically displayed in a JScrollPane (JTable, JList, JTree, JTextArea, and JEditorPane) already handle mouse dragged events in this way. To enable autoscrolling in any other component, add a mouse motion listener that calls scrollRectToVisible. For example, given a JPanel, myPanel:

 MouseMotionListener doScrollRectToVisible = new MouseMotionAdapter() {
 public void mouseDragged(MouseEvent e) {
 Rectangle r = new Rectangle(e.getX(), e.getY(), 1, 1);
 ((JPanel)e.getSource()).scrollRectToVisible(r);
 }
 };
 myPanel.addMouseMotionListener(doScrollRectToVisible);
 

The default value of the autoScrolls property is false.

Parameters:

event - the MouseEvent that triggered the popup to be shown, or null if popup was is not being shown as the result of a mouse event autoscrolls - if true, synthetic mouse dragged events are generated when the mouse is dragged outside of a component's bounds and the mouse button continues to be held down; otherwise false

Returns: See Also:

Locatino to display the JPopupMenu.

Since:

1.5

getAutoscrolls() , JViewport , JScrollPane

---

createToolTip getAutoscrolls

public JToolTip
public boolean createToolTip getAutoscrolls ()

Returns the instance of JToolTip that should be used to display the tooltip. Components typically would not override this method, but it can be used to cause different tooltips to be displayed differently. Gets the autoscrolls property.

Returns:

the JToolTip used to display this toolTip the value of the autoscrolls property

See Also:

JViewport , setAutoscrolls(boolean)

---

scrollRectToVisible setTransferHandler

public void scrollRectToVisible setTransferHandler ( RectangleTransferHandler aRect)  newHandler) 

Forwards the scrollRectToVisible() message to the JComponent's parent. Components that can service the request, such as JViewport, override this method and perform the scrolling. Sets the transferHandler property, which is null if the component does not support data transfer operations.

If newHandler is not null, and the system property suppressSwingDropSupport is not true, this will install a DropTarget on the JComponent. The default for the system property is false, so that a DropTarget will be added.

Parameters:

aRect - the visible Rectangle newHandler - mechanism for transfer of data to and from the component

Since:

1.4

See Also:

JViewport TransferHandler , getTransferHandler()

---

setAutoscrolls getTransferHandler

public void 
public TransferHandlersetAutoscrolls getTransferHandler (boolean autoscrolls) () 

Sets the autoscrolls property. If true mouse dragged events will be synthetically generated when the mouse is dragged outside of the component's bounds and mouse motion has paused (while the button continues to be held down). The synthetic events make it appear that the drag gesture has resumed in the direction established when the component's boundary was crossed. Components that support autoscrolling must handle mouseDragged events by calling scrollRectToVisible with a rectangle that contains the mouse event's location. All of the Swing components that support item selection and are typically displayed in a JScrollPane (JTable, JList, JTree, JTextArea, and JEditorPane) already handle mouse dragged events in this way. To enable autoscrolling in any other component, add a mouse motion listener that calls scrollRectToVisible. For example, given a JPanel, myPanel:

 MouseMotionListener doScrollRectToVisible = new MouseMotionAdapter() {
 public void mouseDragged(MouseEvent e) {
 Rectangle r = new Rectangle(e.getX(), e.getY(), 1, 1);
 ((JPanel)e.getSource()).scrollRectToVisible(r);
 }
 };
 myPanel.addMouseMotionListener(doScrollRectToVisible);
 

The default value of the autoScrolls property is false. Gets the transferHandler property.

Parameters: Returns:

autoscrolls - if true, synthetic mouse dragged events are generated when the mouse is dragged outside of a component's bounds and the mouse button continues to be held down; otherwise false the value of the transferHandler property

Since:

1.4

See Also:

getAutoscrolls() TransferHandler , JViewport setTransferHandler(javax.swing.TransferHandler) , JScrollPane

---

getAutoscrolls processMouseMotionEvent

public boolean 
protected void getAutoscrolls processMouseMotionEvent () ( MouseEvent e) 

Gets the autoscrolls property. Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.

Overrides:

processMouseMotionEvent in class Component

Returns: Parameters:

the value of the autoscrolls property e - the MouseEvent

See Also:

JViewport MouseEvent , setAutoscrolls(boolean)

---

setTransferHandler enable

public void setTransferHandler enable ( TransferHandler newHandler) () 

Sets the transferHandler property, which is null if the component does not support data transfer operations. Deprecated.   As of JDK version 1.1, replaced by java.awt.Component.setEnable(boolean).

If newHandler is not null, and the system property suppressSwingDropSupport is not true, this will install a DropTarget on the JComponent. The default for the system property is false, so that a DropTarget will be added.

Please see How to Use Drag and Drop and Data Transfer , a section in The Java Tutorial, for more information.

Parameters: Overrides:

newHandler - mechanism for transfer of data to and from the component

Since:

1.4 enable in class Component

See Also:

TransferHandler , getTransferHandler()

---

getTransferHandler disable

public TransferHandler
public void getTransferHandler disable ()

Gets the transferHandler property. Deprecated.   As of JDK version 1.1, replaced by java.awt.Component.setEnable(boolean).

Returns: Overrides:

the value of the transferHandler property

Since:

1.4 disable in class Component

See Also:

TransferHandler , setTransferHandler(javax.swing.TransferHandler)

---

processMouseEvent getAccessibleContext

protected void 
public AccessibleContextprocessMouseEvent getAccessibleContext ( MouseEvent e) () 

Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects, refer to Component.processMouseEvent(MouseEvent) for a complete description of this method. Returns the AccessibleContext associated with this JComponent. The method implemented by this base class returns null. Classes that extend JComponent should implement this method to return the AccessibleContext associated with the subclass.

Overrides:

processMouseEvent getAccessibleContext in class Component

Parameters: Returns:

e - the mouse event

Since:

1.5

See Also:

Component.processMouseEvent(java.awt.event.MouseEvent) the AccessibleContext of this JComponent

---

processMouseMotionEvent getClientProperty

protected void 
public final ObjectprocessMouseMotionEvent getClientProperty ( MouseEventObject e)  key) 

Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED. Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value.

Overrides:

processMouseMotionEvent in class Component

Parameters:

e - the MouseEvent key - the being queried

Returns:

the value of this property or null

See Also:

MouseEvent putClientProperty(java.lang.Object, java.lang.Object)

---

enable putClientProperty

public final void enable putClientProperty () ( Object key,
 Object value) 

Adds an arbitrary key/value "client property" to this component.

The get/putClientProperty methods provide access to a small per-instance hashtable. Callers can use get/putClientProperty to annotate components that were created by another module. For example, a layout manager might store per child constraints this way. For example:

 componentA.putClientProperty("to the left of", componentB);
 

If value is null this method will remove the property. Changes to client properties are reported with PropertyChange events. The name of the property (for the sake of PropertyChange events) is key.toString().

The clientProperty dictionary is not intended to support large scale extensions to JComponent nor should be it considered an alternative to subclassing when designing a new component.

Deprecated. Parameters:   As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean).

key - the new client property key

value - the new client property value; if null this method will remove the property

Overrides: See Also:

enable getClientProperty(java.lang.Object) in class Component , addPropertyChangeListener(java.beans.PropertyChangeListener)

---

disable isLightweightComponent

public void 
public static boolean disable isLightweightComponent () ( Component c) 

Deprecated.   As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.

Overrides: Returns:

disable in class Component true if this component is lightweight

---

getAccessibleContext reshape

public AccessibleContext
public void getAccessibleContext reshape () (int x,
 int y,
 int w,
 int h) 

Returns the AccessibleContext associated with this JComponent. The method implemented by this base class returns null. Classes that extend JComponent should implement this method to return the AccessibleContext associated with the subclass. Moves and resizes this component.

Overrides:

getAccessibleContext reshape in class Component

Returns: Parameters:

the AccessibleContext of this JComponent x - the new horizontal location

y - the new vertical location

w - the new width

h - the new height

See Also:

Component.setBounds(int, int, int, int)

---

getClientProperty getBounds

public final Object
public RectanglegetClientProperty getBounds ( ObjectRectangle key)  rv) 

Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value. Stores the bounds of this component into "return value" rv and returns rv. If rv is null a new Rectangle is allocated. This version of getBounds is useful if the caller wants to avoid allocating a new Rectangle object on the heap.

Overrides:

getBounds in class Component

Parameters:

key - the being queried rv - the return value, modified to the component's bounds

Returns:

the value of this property or null

See Also:

putClientProperty(java.lang.Object, java.lang.Object) rv; if rv is null return a newly created Rectangle with this component's bounds

---

putClientProperty getSize

public final void 
public DimensionputClientProperty getSize ( ObjectDimension key,
 Object value)  rv) 

Adds an arbitrary key/value "client property" to this component. Stores the width/height of this component into "return value" rv and returns rv. If rv is null a new Dimension object is allocated. This version of getSize is useful if the caller wants to avoid allocating a new Dimension object on the heap.

The get/putClientProperty methods provide access to a small per-instance hashtable. Callers can use get/putClientProperty to annotate components that were created by another module. For example, a layout manager might store per child constraints this way. For example:

 componentA.putClientProperty("to the left of", componentB);
 

If value is null this method will remove the property. Changes to client properties are reported with PropertyChange events. The name of the property (for the sake of PropertyChange events) is key.toString().

The clientProperty dictionary is not intended to support large scale extensions to JComponent nor should be it considered an alternative to subclassing when designing a new component.

Overrides:

getSize in class Component

Parameters:

key - the new client property key

value - the new client property value; if null this method will remove the property rv - the return value, modified to the component's size

See Also: Returns:

getClientProperty(java.lang.Object) , Container.addPropertyChangeListener(java.beans.PropertyChangeListener) rv

---

setFocusTraversalKeys getLocation

public void 
public PointsetFocusTraversalKeys getLocation (int id,
 Set( Point keystrokes)  rv) 

Sets the focus traversal keys for a given traversal operation for this Component. Refer to Component.setFocusTraversalKeys(int, java.util.Set) for a complete description of this method. Stores the x,y origin of this component into "return value" rv and returns rv. If rv is null a new Point is allocated. This version of getLocation is useful if the caller wants to avoid allocating a new Point object on the heap.

Overrides:

setFocusTraversalKeys getLocation in class Container Component

Parameters:

id - one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS

keystrokes - the Set of AWTKeyStroke for the specified operation rv - the return value, modified to the component's location

Throws: Returns:

IllegalArgumentException - if id is not one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, or KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or if keystrokes contains null, or if any Object in keystrokes is not an AWTKeyStroke, or if any keystroke represents a KEY_TYPED event, or if any keystroke already maps to another focus traversal operation for this Component

Since:

1.5

See Also:

KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS , KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS , KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS rv

---

isLightweightComponent getX

public static boolean 
public int isLightweightComponent getX ( Component c) () 

Returns true if this component is lightweight, that is, if it doesn't have a native window system peer. Returns the current x coordinate of the component's origin. This method is preferable to writing component.getBounds().x, or component.getLocation().x because it doesn't cause any heap allocations.

Overrides:

getX in class Component

Returns:

true if this component is lightweight the current x coordinate of the component's origin

---

reshape getY

public void int reshape getY (int x,
 int y,
 int w,
 int h) () 

Deprecated.   As of JDK version 1.5, replaced by Component.setBounds(int, int, int, int). Returns the current y coordinate of the component's origin. This method is preferable to writing component.getBounds().y, or component.getLocation().y because it doesn't cause any heap allocations.

Moves and resizes this component.

Overrides:

reshape getY in class Component

Parameters: Returns:

x - the new horizontal location

y - the new vertical location

w - the new width

h - the new height

See Also:

Component.setBounds(int, int, int, int) the current y coordinate of the component's origin

---

getBounds getWidth

public Rectangle
public int getBounds getWidth ( Rectangle rv) () 

Stores the bounds of this component into "return value" rv and returns rv. If rv is null a new Rectangle is allocated. This version of getBounds is useful if the caller wants to avoid allocating a new Rectangle object on the heap. Returns the current width of this component. This method is preferable to writing component.getBounds().width, or component.getSize().width because it doesn't cause any heap allocations.

Overrides:

getBounds getWidth in class Component

Parameters:

rv - the return value, modified to the component's bounds

Returns:

rv; if rv is null return a newly created Rectangle with this component's bounds the current width of this component

---

getSize getHeight

public Dimension
public int getSize getHeight ( Dimension rv) () 

Stores the width/height of this component into "return value" rv and returns rv. If rv is null a new Dimension object is allocated. This version of getSize is useful if the caller wants to avoid allocating a new Dimension object on the heap. Returns the current height of this component. This method is preferable to writing component.getBounds().height, or component.getSize().height because it doesn't cause any heap allocations.

Overrides:

getSize getHeight in class Component

Parameters:

rv - the return value, modified to the component's size

Returns:

rv the current height of this component

---

getLocation isOpaque

public Point
public boolean getLocation isOpaque ( Point rv) () 

Stores the x,y origin of this component into "return value" rv and returns rv. If rv is null a new Point is allocated. This version of getLocation is useful if the caller wants to avoid allocating a new Point object on the heap. Returns true if this component is completely opaque.

An opaque component paints every pixel within its rectangular bounds. A non-opaque component paints only a subset of its pixels or none at all, allowing the pixels underneath it to "show through". Therefore, a component that does not fully paint its pixels provides a degree of transparency.

Subclasses that guarantee to always completely paint their contents should override this method and return true.

Overrides:

getLocation isOpaque in class Component

Parameters: Returns:

rv - the return value, modified to the component's location true if this component is completely opaque

Returns: See Also:

rv setOpaque(boolean)

---

getX setOpaque

public int void getX setOpaque () (boolean isOpaque) 

Returns the current x coordinate of the component's origin. This method is preferable to writing component.getBounds().x, or component.getLocation().x because it doesn't cause any heap allocations. If true the component paints every pixel within its bounds. Otherwise, the component may not paint some or all of its pixels, allowing the underlying pixels to show through.

The default value of this property is false for JComponent. However, the default value for this property on most standard JComponent subclasses (such as JButton and JTree) is look-and-feel dependent.

Overrides: Parameters:

getX in class Component

isOpaque - true if this component should be opaque

Returns: See Also:

the current x coordinate of the component's origin isOpaque()

---

getY computeVisibleRect

public int void getY computeVisibleRect () ( Rectangle visibleRect) 

Returns the current y coordinate of the component's origin. This method is preferable to writing component.getBounds().y, or component.getLocation().y because it doesn't cause any heap allocations. Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors. The return value is stored in visibleRect.

Overrides: Parameters:

getY in class Component

visibleRect - a Rectangle computed as the intersection of all visible rectangles for this component and all of its ancestors -- this is the return value for this method

Returns: See Also:

the current y coordinate of the component's origin getVisibleRect()

---

getWidth getVisibleRect

public int 
public RectanglegetWidth getVisibleRect ()

Returns the current width of this component. This method is preferable to writing component.getBounds().width, or component.getSize().width because it doesn't cause any heap allocations. Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle:

 new Rectangle(0, 0, getWidth(), getHeight());
 

and all of its ancestors' visible rectangles.

Overrides:

getWidth in class Component

Returns:

the current width of this component the visible rectangle

---

getHeight firePropertyChange

public int 
protected void getHeight firePropertyChange () ( String propertyName,
 Object oldValue,
 Object newValue) 

Returns the current height of this component. This method is preferable to writing component.getBounds().height, or component.getSize().height because it doesn't cause any heap allocations. Supports reporting bound property changes. If oldValue and newValue are not equal and the PropertyChangeEvent listener list isn't empty, then fire a PropertyChange event to each listener. This method has an overloaded method for each primitive type. For example, here's how to write a bound property set method whose value is an integer:

 public void setFoo(int newValue) {
 int oldValue = foo;
 foo = newValue;
 firePropertyChange("foo", oldValue, newValue);
 }
 

Overrides:

getHeight firePropertyChange in class Component

Returns: Parameters:

the current height of this component propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as an Object)

newValue - the new value of the property (as an Object)

See Also:

PropertyChangeSupport

---

isOpaque firePropertyChange

public boolean void isOpaque firePropertyChange () ( String propertyName,
 byte oldValue,
 byte newValue) 

Returns true if this component is completely opaque. Reports a bound property change.

An opaque component paints every pixel within its rectangular bounds. A non-opaque component paints only a subset of its pixels or none at all, allowing the pixels underneath it to "show through". Therefore, a component that does not fully paint its pixels provides a degree of transparency.

Subclasses that guarantee to always completely paint their contents should override this method and return true.

Overrides:

isOpaque in class Component

Returns: Parameters:

true if this component is completely opaque propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a byte)

newValue - the new value of the property (as a byte)

See Also:

setOpaque(boolean) firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

setOpaque firePropertyChange

public void setOpaque firePropertyChange (boolean isOpaque) ( String propertyName,
 char oldValue,
 char newValue) 

If true the component paints every pixel within its bounds. Otherwise, the component may not paint some or all of its pixels, allowing the underlying pixels to show through. Reports a bound property change.

The default value of this property is false for JComponent. However, the default value for this property on most standard JComponent subclasses (such as JButton and JTree) is look-and-feel dependent.

Parameters:

isOpaque - true if this component should be opaque propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a char)

newValue - the new value of the property (as a char)

See Also:

isOpaque() firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

computeVisibleRect firePropertyChange

public void computeVisibleRect firePropertyChange ( RectangleString visibleRect)  propertyName,
 short oldValue,
 short newValue) 

Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors. The return value is stored in visibleRect. Reports a bound property change.

Parameters:

visibleRect - a Rectangle computed as the intersection of all visible rectangles for this component and all of its ancestors -- this is the return value for this method propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a short)

newValue - the old value of the property (as a short)

See Also:

getVisibleRect() firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

getVisibleRect firePropertyChange

public Rectangle
public void getVisibleRect firePropertyChange () ( String propertyName,
 int oldValue,
 int newValue) 

Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle, new Rectangle(0, 0, getWidth(), getHeight()), and all of its ancestors' visible rectangles. Reports a bound property change.

Overrides:

firePropertyChange in class Component

Returns: Parameters:

the visible rectangle propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as an int)

newValue - the new value of the property (as an int)

See Also:

firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

firePropertyChange

 
public void firePropertyChange ( String propertyName,
 long oldValue,
 long newValue) 

Reports a bound property change.

Parameters:

propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a long)

newValue - the new value of the property (as a long)

See Also:

firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

firePropertyChange

 
public void firePropertyChange ( String propertyName,
 float oldValue,
 float newValue) 

Reports a bound property change.

Parameters:

propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a float)

newValue - the new value of the property (as a float)

See Also:

firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

firePropertyChange

 
public void firePropertyChange ( String propertyName,
 double oldValue,
 double newValue) 

Reports a bound property change.

Parameters:

propertyName - the programmatic name of the property that was changed

oldValue - the old value of the property (as a double)

newValue - the new value of the property (as a double)

See Also:

firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

firePropertyChange

public void firePropertyChange(String propertyName,
                               boolean oldValue,
                               boolean newValue)

Support for reporting bound property changes for boolean properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners. Reports a bound property change.

Overrides:

firePropertyChange in class Component

Parameters:

propertyName - the property whose value has changed propertyName - the programmatic name of the property that was changed

oldValue - the property's previous value oldValue - the old value of the property (as a boolean)

newValue - the property's new value newValue - the new value of the property (as a boolean)

See Also:

firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

---

firePropertyChange addPropertyChangeListener

public void firePropertyChange addPropertyChangeListener ( StringPropertyChangeListener propertyName,
 int oldValue,
 int newValue)  listener) 

Support for reporting bound property changes for integer properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners. Adds a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired in response to setting a bound property, such as setFont, setBackground, or setForeground.

Note that if the current component is inheriting its foreground, background, or font from its container, then no event will be fired in response to a change in the inherited property.

Overrides:

firePropertyChange addPropertyChangeListener in class Component Container

Parameters:

propertyName - the property whose value has changed listener - the PropertyChangeListener to be added

See Also:

oldValue - the property's previous value

newValue - the property's new value Component.removePropertyChangeListener(java.beans.PropertyChangeListener) , Container.addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

---

firePropertyChange addPropertyChangeListener

public void firePropertyChange addPropertyChangeListener (String propertyName,
 char oldValue,
 char newValue)  propertyName,
 PropertyChangeListener listener) 

Description copied from class: Component

Reports a bound property change. Adds a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property.

If listener is null, no exception is thrown and no action is performed.

Overrides:

firePropertyChange addPropertyChangeListener in class Component Container

Parameters:

propertyName - the programmatic name of the property that was changed property to listen on

oldValue - the old value of the property (as a char)

newValue - the new value of the property (as a char) listener - the PropertyChangeListener to be added

See Also:

Component.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object) Container.addPropertyChangeListener(java.beans.PropertyChangeListener) , Component.removePropertyChangeListener(java.beans.PropertyChangeListener)

---

removePropertyChangeListener

 
public void removePropertyChangeListener ( PropertyChangeListener listener) 

Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Overrides:

removePropertyChangeListener in class Component

Parameters:

listener - the PropertyChangeListener to be removed

See Also:

Component.addPropertyChangeListener(java.beans.PropertyChangeListener) , Component.getPropertyChangeListeners() , Component.removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)

---

removePropertyChangeListener

 
public void removePropertyChangeListener ( String propertyName,
 PropertyChangeListener listener) 

Removes a PropertyChangeListener for a specific property. If listener is null, no exception is thrown and no action is performed.

Overrides:

removePropertyChangeListener in class Component

Parameters:

propertyName - the name of the property that was listened on

listener - the PropertyChangeListener to be removed

See Also:

Component.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) , Component.getPropertyChangeListeners(java.lang.String) , Component.removePropertyChangeListener(java.beans.PropertyChangeListener)

---

getPropertyChangeListeners

 
public PropertyChangeListener[] getPropertyChangeListeners () 

Returns an array of all the PropertyChangeListeners added to this Component with addPropertyChangeListener().

Overrides:

getPropertyChangeListeners in class Component

Returns:

all of the PropertyChangeListeners added or an empty array if no listeners have been added

Since:

1.4

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener) , removePropertyChangeListener(java.beans.PropertyChangeListener) , getPropertyChangeListeners(java.lang.String) , PropertyChangeSupport.getPropertyChangeListeners()

---

getPropertyChangeListeners

 
public PropertyChangeListener[] getPropertyChangeListeners ( String propertyName) 

Returns an array of all the listeners which have been associated with the named property.

Overrides:

getPropertyChangeListeners in class Component

Returns:

all of the PropertyChangeListeners associated with the named property or an empty array if no listeners have been added

Since:

1.4

See Also:

getPropertyChangeListeners()

---

fireVetoableChange

protected void fireVetoableChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)
                           throws PropertyVetoException

Supports reporting constrained property changes. This method can be called when a constrained property has changed and it will send the appropriate PropertyChangeEvent to any registered VetoableChangeListeners.

Parameters:

propertyName - the name of the property that was listened on

oldValue - the old value of the property

newValue - the new value of the property

Throws:

PropertyVetoException - when the attempt to set the property is vetoed by the component

---

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Adds a VetoableChangeListener to the listener list. The listener is registered for all properties.

Parameters:

listener - the VetoableChangeListener to be added

---

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Removes a VetoableChangeListener from the listener list. This removes a VetoableChangeListener that was registered for all properties.

Parameters:

listener - the VetoableChangeListener to be removed

---

getVetoableChangeListeners

public VetoableChangeListener[] getVetoableChangeListeners()

Returns an array of all the vetoable change listeners registered on this component.

Returns:

all of the component's VetoableChangeListeners or an empty array if no vetoable change listeners are currently registered

Since:

1.4

See Also:

addVetoableChangeListener(java.beans.VetoableChangeListener) , removeVetoableChangeListener(java.beans.VetoableChangeListener)

---

getTopLevelAncestor

public Container getTopLevelAncestor()

Returns the top-level ancestor of this component (either the containing Window or Applet), or null if this component has not been added to any container.

Returns:

the top-level Container that this component is in, or null if not in any container

---

addAncestorListener

public void addAncestorListener(AncestorListener listener)

Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible. Events are also sent when the component or its ancestors are added or removed from the containment hierarchy.

Parameters:

listener - the AncestorListener to register

See Also:

AncestorEvent

---

removeAncestorListener

public void removeAncestorListener(AncestorListener listener)

Unregisters listener so that it will no longer receive AncestorEvents.

Parameters:

listener - the AncestorListener to be removed

See Also:

addAncestorListener(javax.swing.event.AncestorListener)

---

getAncestorListeners

public AncestorListener[] getAncestorListeners()

Returns an array of all the ancestor listeners registered on this component.

Returns:

all of the component's AncestorListeners or an empty array if no ancestor listeners are currently registered

Since:

1.4

See Also:

addAncestorListener(javax.swing.event.AncestorListener) , removeAncestorListener(javax.swing.event.AncestorListener)

---

getListeners

public EventListener[] getListeners(Class listenerType)

Returns an array of all the objects currently registered as FooListeners upon this JComponent. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a JComponent c for its mouse listeners with the following code:

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));

If no such listeners exist, this method returns an empty array.

Overrides:

getListeners in class Container

Parameters:

listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:

an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added

Throws:

ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener

Since:

1.3

See Also:

getVetoableChangeListeners() , getAncestorListeners()

---

addNotify

public void addNotify()

Notifies this component that it now has a parent component. When this method is invoked, the chain of parent components is set up with KeyboardAction event listeners.

Overrides:

addNotify in class Container

See Also:

registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

---

removeNotify

public void removeNotify()

Notifies this component that it no longer has a parent component. When this method is invoked, any KeyboardActions set up in the the chain of parent components are removed.

Overrides:

removeNotify in class Container

See Also:

registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

---

repaint

public void repaint(long tm,
                    int x,
                    int y,
                    int width,
                    int height)

Adds the specified region to the dirty region list if the component is showing. The component will be repainted after all of the currently pending events have been dispatched.

Overrides:

repaint in class Component

Parameters:

tm - this parameter is not used

x - the x value of the dirty region

y - the y value of the dirty region

width - the width of the dirty region

height - the height of the dirty region

See Also:

Component.isShowing() , RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)

---

repaint

public void repaint(Rectangle r)

Adds the specified region to the dirty region list if the component is showing. The component will be repainted after all of the currently pending events have been dispatched.

Parameters:

r - a Rectangle containing the dirty region

See Also:

Component.isShowing() , RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)

---

revalidate

public void revalidate()

Supports deferred automatic layout.

Calls invalidate and then adds this component's validateRoot to a list of components that need to be validated. Validation will occur after all currently pending events have been dispatched. In other words after this method is called, the first validateRoot (if any) found when walking up the containment hierarchy of this component will be validated. By default, JRootPane, JScrollPane, and JTextField return true from isValidateRoot.

This method will automatically be called on this component when a property value changes such that size, location, or internal layout of this component has been affected. This automatic updating differs from the AWT because programs generally no longer need to invoke validate to get the contents of the GUI to update.

See Also:

Component.invalidate() , Container.validate() , isValidateRoot() , RepaintManager.addInvalidComponent(javax.swing.JComponent)

---

isValidateRoot

public boolean isValidateRoot()

If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated. Returns false by default. JScrollPane overrides this method and returns true.

Returns:

always returns false

See Also:

revalidate() , Component.invalidate() , Container.validate()

---

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap. The repainting system is substantially more efficient in this common case. JComponent subclasses that can't make this guarantee, such as JLayeredPane, should override this method to return false.

Returns:

always returns true

---

paintImmediately

public void paintImmediately(int x,
                             int y,
                             int w,
                             int h)

Paints the specified region in this component and all of its descendants that overlap the region, immediately.

It's rarely necessary to call this method. In most cases it's more efficient to call repaint, which defers the actual painting and can collapse redundant requests into a single paint call. This method is useful if one needs to update the display while the current event is being dispatched.

Parameters:

x - the x value of the region to be painted

y - the y value of the region to be painted

w - the width of the region to be painted

h - the height of the region to be painted

See Also:

repaint(long, int, int, int, int)

---

paintImmediately

public void paintImmediately(Rectangle r)

Paints the specified region now.

Parameters:

r - a Rectangle containing the region to be painted

---

setDoubleBuffered

public void setDoubleBuffered(boolean aFlag)

Sets whether the this component should use a buffer to paint. If set to true, all the drawing from this component will be done in an offscreen painting buffer. The offscreen painting buffer will the be copied onto the screen. Swings painting system always uses a maximum of one double buffer. If a Component is buffered and one of its ancestor is also buffered, the ancestor buffer will be used.

Parameters:

aFlag - if true, set this component to be double buffered

---

isDoubleBuffered

public boolean isDoubleBuffered()

Returns whether this component should use a buffer to paint.

Overrides:

isDoubleBuffered in class Component

Returns:

true if this component is double buffered, otherwise false

---

getRootPane

public JRootPane getRootPane()

Returns the JRootPane ancestor for this component.

Returns:

the JRootPane that contains this component, or null if no JRootPane is found

---

paramString

protected String paramString()

Returns a string representation of this JComponent. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class Container

Returns:

a string representation of this JComponent

---

---