JComponent (Java 2 Platform SE v1.4.1)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Std. Ed. v1.4.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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.

For more information on these subjects, see the Swing package description and The Java Tutorial section The JComponent Class.

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

Nested classes inherited from class java.awt.Component

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 listener)
          Adds a PropertyChangeListener to the listener list.

void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
          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.setEnable(boolean).

void enable()
          Deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnable(boolean).

void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, byte oldValue, byte newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, char oldValue, char newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, double oldValue, double newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, float oldValue, float newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, int oldValue, int newValue)
          Reports a bound property change.

void firePropertyChange(String propertyName, long oldValue, long newValue)
          Reports a bound property change.

protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Supports reporting bound property changes.

void firePropertyChange(String propertyName, short oldValue, short newValue)
          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.

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.

Graphics getGraphics()
          Returns this component's graphics context, which lets you draw on a component.

int getHeight()
          Returns the current height of this component.

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.

Dimension getPreferredSize()
          If the preferredSize has been set to a non-null value just returns it.

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

PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
          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:

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 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 listener)
          Removes a PropertyChangeListener from the listener list.

void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
          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 get the input focus, and that this Component's top-level ancestor become the focused Window.

boolean requestFocus(boolean temporary)
          JComponent overrides requestFocus solely to make the method public so that UI implementations can cause temporary focus changes.

boolean requestFocusInWindow()
          Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.

protected boolean requestFocusInWindow(boolean temporary)
          JComponent overrides requestFocusInWindow solely to make the method public so that 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)
          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 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 setFont(Font font)
          Sets the font for this component.

void setForeground(Color fg)
          Sets the foreground color of this component.

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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, 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.

Constructor Detail

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()

Method Detail

updateUI

public void updateUI()

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);
   }

See Also:: setUI(javax.swing.plaf.ComponentUI), UIManager.getLookAndFeel(), UIManager.getUI(javax.swing.JComponent)

setUI

protected void setUI(ComponentUI newUI)

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;
 }

Parameters:: newUI - the new UI delegate
See Also:: updateUI(), UIManager.getLookAndFeel(), UIManager.getUI(javax.swing.JComponent)

getUIClassID

public 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. 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.

Returns:: the UIDefaults key for a ComponentUI subclass
See Also:: UIDefaults.getUI(javax.swing.JComponent)

getComponentGraphics

protected Graphics getComponentGraphics(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.

Parameters:: g - the original Graphics object
Returns:: a Graphics object configured for this component

paintComponent

protected void paintComponent(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).

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:: paint(java.awt.Graphics), ComponentUI

paintChildren

protected void paintChildren(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.

Parameters:: g - the Graphics context in which to paint
See Also:: paint(java.awt.Graphics), Container.paint(java.awt.Graphics)

paintBorder

protected void paintBorder(Graphics g)

Paints the component's border.

Parameters:: g - the Graphics context in which to paint
See Also:: paint(java.awt.Graphics), setBorder(javax.swing.border.Border)

update

public void update(Graphics g)

Calls paint. Doesn't clear the background but see ComponentUI.update, which is called by paintComponent.

Overrides:: update in class Container

Parameters:: g - the Graphics context in which to paint
See Also:: paint(java.awt.Graphics), paintComponent(java.awt.Graphics), ComponentUI

paint

public void paint(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.

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
See Also:: paintComponent(java.awt.Graphics), paintBorder(java.awt.Graphics), paintChildren(java.awt.Graphics), getComponentGraphics(java.awt.Graphics), repaint(long, int, int, int, int)

printAll

public void printAll(Graphics g)

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:: print(java.awt.Graphics), printComponent(java.awt.Graphics), printBorder(java.awt.Graphics), printChildren(java.awt.Graphics)

print

public void print(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.

Overrides:: print in class Container

Parameters:: g - the Graphics context in which to paint
See Also:: printComponent(java.awt.Graphics), printBorder(java.awt.Graphics), printChildren(java.awt.Graphics)

printComponent

protected void printComponent(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.

Parameters:: g - the Graphics context in which to paint
Since:: 1.3
See Also:: print(java.awt.Graphics)

printChildren

protected void printChildren(Graphics g)

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.

Parameters:: g - the Graphics context in which to paint
Since:: 1.3
See Also:: print(java.awt.Graphics)

printBorder

protected void printBorder(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.

Parameters:: g - the Graphics context in which to paint
Since:: 1.3
See Also:: print(java.awt.Graphics)

isPaintingTile

public boolean isPaintingTile()

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.

Returns:: true if the component is currently painting a tile, false otherwise

isManagingFocus

public boolean isManagingFocus()

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.

See Also:: Component.setFocusTraversalKeys(int, java.util.Set), SortingFocusTraversalPolicy

setNextFocusableComponent

public void setNextFocusableComponent(Component aComponent)

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:: aComponent - the Component that should follow this JComponent in the focus traversal cycle
See Also:: getNextFocusableComponent(), FocusTraversalPolicy

getNextFocusableComponent

public Component getNextFocusableComponent()

Deprecated. As of 1.4, replaced by FocusTraversalPolicy.

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

Returns:: the Component that will follow this JComponent in the focus traversal cycle, or null if none has been explicitly specified
See Also:: setNextFocusableComponent(java.awt.Component)

setRequestFocusEnabled

public void setRequestFocusEnabled(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.

Parameters:: requestFocusEnabled - Indicates if you want this JComponent to be focusable or not
See Also:: Focus Specification, Component.setFocusable(boolean)

isRequestFocusEnabled

public boolean isRequestFocusEnabled()

Returns true if this JComponent should get focus; otherwise returns false.

Returns:: true if this component should get focus, otherwise returns false
See Also:: setRequestFocusEnabled(boolean), Focus Specification, Component.isFocusable()

requestFocus

public void requestFocus()

Description copied from class: Component

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.

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

Because the focus behavior of this method is platform-dependent, developers are strongly encouraged to use requestFocusInWindow when possible.

Overrides:: requestFocus in class Component

See Also:: Component.requestFocusInWindow(), FocusEvent, Component.addFocusListener(java.awt.event.FocusListener), Component.isFocusable(), Component.isDisplayable(), KeyboardFocusManager.clearGlobalFocusOwner()

requestFocus

public boolean requestFocus(boolean temporary)

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.

Refer to Component.requestFocus(boolean) for a complete description of this method.

Overrides:: requestFocus 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.requestFocus(), Component.requestFocusInWindow(), Component.requestFocus(boolean), Component.requestFocusInWindow(boolean)

requestFocusInWindow

public boolean requestFocusInWindow()

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.

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

Returns:: false if the focus change request is guaranteed to fail; true if it is likely to succeed
See Also:: Component.requestFocus(), FocusEvent, Component.addFocusListener(java.awt.event.FocusListener), Component.isFocusable(), Component.isDisplayable(), KeyboardFocusManager.clearGlobalFocusOwner()

requestFocusInWindow

protected boolean requestFocusInWindow(boolean temporary)

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.

Refer to Component.requestFocusInWindow(boolean) for a complete description of this method.

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.requestFocus(), Component.requestFocusInWindow(), Component.requestFocus(boolean), Component.requestFocusInWindow(boolean)

grabFocus

public void grabFocus()

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

See Also:: requestFocus()

setVerifyInputWhenFocusTarget

public 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. 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.

Since:: 1.3
See Also:: InputVerifier, setInputVerifier(javax.swing.InputVerifier), getInputVerifier(), getVerifyInputWhenFocusTarget()

getVerifyInputWhenFocusTarget

public boolean getVerifyInputWhenFocusTarget()

Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.

Returns:: value of the verifyInputWhenFocusTarget property
Since:: 1.3
See Also:: InputVerifier, setInputVerifier(javax.swing.InputVerifier), getInputVerifier(), setVerifyInputWhenFocusTarget(boolean)

setPreferredSize

public void setPreferredSize(Dimension preferredSize)

Sets the preferred size of this component. If preferredSize is null, the UI will be asked for the preferred size.

getPreferredSize

public Dimension getPreferredSize()

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.

Overrides:: getPreferredSize in class Container

Returns:: the value of the preferredSize property
See Also:: setPreferredSize(java.awt.Dimension), ComponentUI

setMaximumSize

public void setMaximumSize(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.

Parameters:: maximumSize - a Dimension containing the desired maximum allowable size
See Also:: getMaximumSize()

getMaximumSize

public Dimension getMaximumSize()

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 maximumSize property
See Also:: setMaximumSize(java.awt.Dimension), ComponentUI

setMinimumSize

public void setMinimumSize(Dimension minimumSize)

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.

Parameters:: minimumSize - the new minimum size of this component
See Also:: getMinimumSize()

getMinimumSize

public Dimension getMinimumSize()

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:: getMinimumSize in class Container

Returns:: the value of the minimumSize property
See Also:: setMinimumSize(java.awt.Dimension), ComponentUI

isMinimumSizeSet

public boolean isMinimumSizeSet()

Returns true if the minimum size has been set to a non-null value otherwise returns false.

Returns:: true if minimumSize is non-null, false otherwise
Since:: 1.3

isPreferredSizeSet

public boolean isPreferredSizeSet()

Returns true if the preferred size has been set to a non-null value otherwise returns false.

Returns:: true if preferredSize is non-null, false otherwise
Since:: 1.3

isMaximumSizeSet

public boolean isMaximumSizeSet()

Returns true if the maximum size has been set to a non-null value otherwise returns false.

Returns:: true if maximumSize is non-null, false otherwise
Since:: 1.3

contains

public 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.

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
See Also:: Component.contains(int, int), ComponentUI

setBorder

public void setBorder(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.

This is a bound property.

Parameters:: border - the border to be rendered for this component
See Also:: Border, CompoundBorder

getBorder

public Border getBorder()

Returns the border of this component or null if no border is currently set.

Returns:: the border object for this component
See Also:: setBorder(javax.swing.border.Border)

getInsets

public Insets getInsets()

If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets.

Overrides:: getInsets in class Container

Returns:: the value of the insets property
See Also:: setBorder(javax.swing.border.Border)

getInsets

public Insets getInsets(Insets insets)

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 Insets object
See Also:: getInsets()

getAlignmentY

public float getAlignmentY()

Overrides Container.getAlignmentY to return the horizontal alignment.

Overrides:: getAlignmentY in class Container

Returns:: the value of the alignmentY property
See Also:: setAlignmentY(float), Component.getAlignmentY()

setAlignmentY

public void setAlignmentY(float alignmentY)

Sets the the horizontal alignment.

Parameters:: alignmentY - the new horizontal alignment
See Also:: getAlignmentY()

getAlignmentX

public float getAlignmentX()

Overrides Container.getAlignmentX to return the vertical alignment.

Overrides:: getAlignmentX in class Container

Returns:: the value of the alignmentX property
See Also:: setAlignmentX(float), Component.getAlignmentX()

setAlignmentX

public void setAlignmentX(float alignmentX)

Sets the the vertical alignment.

Parameters:: alignmentX - the new vertical alignment
See Also:: getAlignmentX()

setInputVerifier

public void setInputVerifier(InputVerifier inputVerifier)

Sets the input verifier for this component.

Parameters:: inputVerifier - the new input verifier
Since:: 1.3
See Also:: InputVerifier

getInputVerifier

public InputVerifier getInputVerifier()

Returns the input verifier for this component.

Returns:: the inputVerifier property
Since:: 1.3
See Also:: InputVerifier

getGraphics

public Graphics getGraphics()

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

Returns:: this components graphics context
See Also:: Component.paint(java.awt.Graphics)

setDebugGraphicsOptions

public void setDebugGraphicsOptions(int debugOptions)

Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.

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

getDebugGraphicsOptions

public int getDebugGraphicsOptions()

Returns the state of graphics debugging.

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

public 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. 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:: 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

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

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

unregisterKeyboardAction

public void unregisterKeyboardAction(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.

Unregisters a keyboard action. This will remove the binding from the ActionMap (if it exists) as well as the InputMaps.

getRegisteredKeyStrokes

public KeyStroke[] getRegisteredKeyStrokes()

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)

getConditionForKeyStroke

public int getConditionForKeyStroke(KeyStroke aKeyStroke)

Returns the condition that determines whether a registered action occurs in response to the specified keystroke.

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

public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)

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

Returns:: the ActionListener object invoked when the keystroke occurs

resetKeyboardActions

public void resetKeyboardActions()

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.

setInputMap

public final void setInputMap(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.

Parameters:: 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

getInputMap

public final InputMap getInputMap(int condition)

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

getInputMap

public final InputMap getInputMap()

Returns the InputMap that is used when the component has focus. This is convenience method for getInputMap(WHEN_FOCUSED).

Returns:: the InputMap used when the component has focus
Since:: JDK1.3

setActionMap

public final void setActionMap(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.

Parameters:: am - the new ActionMap
Since:: 1.3

getActionMap

public final ActionMap getActionMap()

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 ActionMap containing the key/action bindings
Since:: 1.3

requestDefaultFocus

public boolean requestDefaultFocus()

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.

See Also:: FocusTraversalPolicy.getDefaultComponent(java.awt.Container)

setVisible

public void setVisible(boolean aFlag)

Makes the component visible or invisible. Overrides Component.setVisible.

Overrides:: setVisible in class Component

Parameters:: aFlag - true to make the component visible; false to make it invisible
See Also:: Component.isVisible()

setEnabled

public void setEnabled(boolean enabled)

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.

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

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:: Component.isEnabled(), Component.isLightweight()

setForeground

public void setForeground(Color fg)

Sets the foreground color of this component.

Overrides:: setForeground in class Component

Parameters:: fg - the desired foreground Color
See Also:: Component.getForeground()

setBackground

public void setBackground(Color bg)

Sets the background color of this component.

Overrides:: setBackground in class Component

Parameters:: bg - the desired background Color
See Also:: Component.getBackground()

setFont

public void setFont(Font font)

Sets the font for this component.

Overrides:: setFont in class Container

Parameters:: font - The font to become this container's font.
See Also:: Component.getFont()

getDefaultLocale

public static Locale getDefaultLocale()

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).

Returns:: the default Locale.
Since:: 1.4
See Also:: setDefaultLocale(java.util.Locale), Component.getLocale(), Component.setLocale(java.util.Locale)

setDefaultLocale

public static void setDefaultLocale(Locale l)

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).

Parameters:: l - the desired default Locale for new components.
Since:: 1.4
See Also:: getDefaultLocale(), Component.getLocale(), Component.setLocale(java.util.Locale)

processComponentKeyEvent

protected void processComponentKeyEvent(KeyEvent e)

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.

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Overrides processKeyEvent to process events.

Overrides:: processKeyEvent in class Component

Parameters:: e - the key event
See Also:: KeyEvent, KeyListener, Component.addKeyListener(java.awt.event.KeyListener), Component.enableEvents(long), Component.isShowing()

processKeyBinding

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. 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.

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

setToolTipText

public void setToolTipText(String text)

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.

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

public String getToolTipText()

Returns the tooltip string that has been set with setToolTipText.

Returns:: the text of the tool tip
See Also:: TOOL_TIP_TEXT_KEY

getToolTipText

public String getToolTipText(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.

getToolTipLocation

public Point getToolTipLocation(MouseEvent event)

Returns the tooltip location in this component's coordinate system. If null is returned, Swing will choose a location. The default implementation returns null.

Parameters:: event - the MouseEvent that caused the ToolTipManager to show the tooltip
Returns:: always returns null

createToolTip

public JToolTip createToolTip()

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

scrollRectToVisible

public void scrollRectToVisible(Rectangle aRect)

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:: aRect - the visible Rectangle
See Also:: JViewport

setAutoscrolls

public void setAutoscrolls(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.

Parameters:: 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
See Also:: getAutoscrolls(), JViewport, JScrollPane

getAutoscrolls

public boolean getAutoscrolls()

Gets the autoscrolls property.

Returns:: the value of the autoscrolls property
See Also:: JViewport, setAutoscrolls(boolean)

setTransferHandler

public void setTransferHandler(TransferHandler newHandler)

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:: newHandler - mechanism for transfer of data to and from the component
Since:: 1.4
See Also:: TransferHandler, getTransferHandler()

getTransferHandler

public TransferHandler getTransferHandler()

Gets the transferHandler property.

Returns:: the value of the transferHandler property
Since:: 1.4
See Also:: TransferHandler, setTransferHandler(javax.swing.TransferHandler)

processMouseMotionEvent

protected void processMouseMotionEvent(MouseEvent e)

Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.

Overrides:: processMouseMotionEvent in class Component

Parameters:: e - the mouse motion event
See Also:: MouseEvent

enable

public void enable()

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

Overrides:: enable in class Component

disable

public void disable()

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

Overrides:: disable in class Component

getAccessibleContext

public AccessibleContext getAccessibleContext()

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:: getAccessibleContext in class Component

Returns:: the AccessibleContext of this JComponent

getClientProperty

public final Object getClientProperty(Object key)

Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value.

Parameters:: key - the being queried
Returns:: the value of this property or null
See Also:: putClientProperty(java.lang.Object, java.lang.Object)

putClientProperty

public final void 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.

Parameters:: key - the new client property key; value - the new client property value; if null this method will remove the property
See Also:: getClientProperty(java.lang.Object), addPropertyChangeListener(java.beans.PropertyChangeListener)

isLightweightComponent

public static boolean isLightweightComponent(Component c)

Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.

Returns:: true if this component is lightweight

reshape

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

Moves and resizes this component.

Overrides:: reshape in class Component

Parameters:: 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)

getBounds

public Rectangle getBounds(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.

Overrides:: getBounds 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

getSize

public Dimension getSize(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.

Overrides:: getSize in class Component

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

getLocation

public Point getLocation(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.

Overrides:: getLocation in class Component

Parameters:: rv - the return value, modified to the component's location
Returns:: rv

getX

public int getX()

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:: the current x coordinate of the component's origin

getY

public int getY()

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.

Overrides:: getY in class Component

Returns:: the current y coordinate of the component's origin

getWidth

public int getWidth()

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:: getWidth in class Component

Returns:: the current width of this component

getHeight

public int getHeight()

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:: getHeight in class Component

Returns:: the current height of this component

isOpaque

public boolean isOpaque()

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:: isOpaque in class Component

Returns:: true if this component is completely opaque
See Also:: setOpaque(boolean)

setOpaque

public void setOpaque(boolean isOpaque)

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.

Parameters:: isOpaque - true if this component should be opaque
See Also:: isOpaque()

computeVisibleRect

public 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. The return value is stored in visibleRect.

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
See Also:: getVisibleRect()

getVisibleRect

public 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.

Returns:: the visible rectangle

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)

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:: firePropertyChange in class Component

Parameters:: 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