Class JComboBox<E>
- Type Parameters:
E- the type of the elements of this combo box
- All Implemented Interfaces:
ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, ListDataListener
@JavaBean(defaultProperty="UI", description="A combination of a text field and a drop-down list.") public class JComboBox<E> extends JComponent implements ItemSelectable, ListDataListener, ActionListener, Accessible
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
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 has been added to the java.beans package. Please see XMLEncoder.
See How to Use Combo Boxes in The Java Tutorial for further information.
- Since:
- 1.2
- See Also:
Nested Class Summary
| Modifier and Type | Class | Description |
|---|---|---|
protected class |
JComboBox.AccessibleJComboBox |
This class implements accessibility support for the JComboBox class. |
static interface |
JComboBox.KeySelectionManager |
The interface that defines a KeySelectionManager. |
Nested classes/interfaces declared in class JComponent
JComponent.AccessibleJComponent | Modifier and Type | Class | Description |
|---|---|---|
class |
JComponent.AccessibleJComponent |
Inner class of JComponent used to provide default support for accessibility. |
Nested classes/interfaces declared in class Container
Container.AccessibleAWTContainer | Modifier and Type | Class | Description |
|---|---|---|
protected class |
Container.AccessibleAWTContainer |
Inner class of Container used to provide default support for accessibility. |
Nested classes/interfaces declared in class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy | Modifier and Type | Class | Description |
|---|---|---|
protected class |
Component.AccessibleAWTComponent |
Inner class of Component used to provide default support for accessibility. |
static enum |
Component.BaselineResizeBehavior |
Enumeration of the common ways the baseline of a component can change as the size changes. |
protected class |
Component.BltBufferStrategy |
Inner class for blitting offscreen surfaces to a component. |
protected class |
Component.FlipBufferStrategy |
Inner class for flipping buffers on a component. |
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
protected String |
actionCommand |
This protected field is implementation specific. |
protected ComboBoxModel |
dataModel |
This protected field is implementation specific. |
protected ComboBoxEditor |
editor |
This protected field is implementation specific. |
protected boolean |
isEditable |
This protected field is implementation specific. |
protected JComboBox.KeySelectionManager |
keySelectionManager |
This protected field is implementation specific. |
protected boolean |
lightWeightPopupEnabled |
This protected field is implementation specific. |
protected int |
maximumRowCount |
This protected field is implementation specific. |
protected ListCellRenderer |
renderer |
This protected field is implementation specific. |
protected Object |
selectedItemReminder |
This protected field is implementation specific. |
Fields declared in class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW | Modifier and Type | Field | Description |
|---|---|---|
protected EventListenerList |
listenerList |
A list of event listeners for this component. |
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". |
protected ComponentUI |
ui |
The look and feel delegate for this component. |
static final int |
UNDEFINED_CONDITION |
Constant used by some of the APIs to mean that no condition is defined. |
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. |
static final int |
WHEN_FOCUSED |
Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus. |
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. |
Fields declared in class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT | Modifier and Type | Field | Description |
|---|---|---|
protected AccessibleContext |
accessibleContext |
The AccessibleContext associated with this Component. |
static final float |
BOTTOM_ALIGNMENT |
Ease-of-use constant for getAlignmentY. |
static final float |
CENTER_ALIGNMENT |
Ease-of-use constant for getAlignmentY and getAlignmentX. |
static final float |
LEFT_ALIGNMENT |
Ease-of-use constant for getAlignmentX. |
static final float |
RIGHT_ALIGNMENT |
Ease-of-use constant for getAlignmentX. |
static final float |
TOP_ALIGNMENT |
Ease-of-use constant for getAlignmentY(). |
Fields declared in interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH | Modifier and Type | Field | Description |
|---|---|---|
static final int |
ABORT |
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete. |
static final int |
ALLBITS |
This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form. |
static final int |
ERROR |
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error. |
static final int |
FRAMEBITS |
This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again. |
static final int |
HEIGHT |
This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method. |
static final int |
PROPERTIES |
This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available. |
static final int |
SOMEBITS |
This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available. |
static final int |
WIDTH |
This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method. |
Constructor Summary
| Constructor | Description |
|---|---|
JComboBox() |
Creates a JComboBox with a default data model. |
JComboBox |
Creates a JComboBox that contains the elements in the specified array. |
JComboBox |
Creates a JComboBox that contains the elements in the specified Vector. |
JComboBox |
Creates a JComboBox that takes its items from an existing ComboBoxModel. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
void |
actionPerformed |
This method is public as an implementation side effect. do not call or override. |
protected void |
actionPropertyChanged |
Updates the combobox's state in response to property changes in associated action. |
void |
addActionListener |
Adds an ActionListener. |
void |
addItem |
Adds an item to the item list. |
void |
addItemListener |
Adds an ItemListener. |
void |
addPopupMenuListener |
Adds a PopupMenu listener which will listen to notification messages from the popup portion of the combo box. |
void |
configureEditor |
Initializes the editor with the specified item. |
protected void |
configurePropertiesFromAction |
Sets the properties on this combobox to match those in the specified Action. |
void |
contentsChanged |
This method is public as an implementation side effect. do not call or override. |
protected PropertyChangeListener |
createActionPropertyChangeListener |
Creates and returns a PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties. |
protected JComboBox.KeySelectionManager |
createDefaultKeySelectionManager() |
Returns an instance of the default key-selection manager. |
protected void |
fireActionEvent() |
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireItemStateChanged |
Notifies all listeners that have registered interest for notification on this event type. |
void |
firePopupMenuCanceled() |
Notifies PopupMenuListeners that the popup portion of the combo box has been canceled. |
void |
firePopupMenuWillBecomeInvisible() |
Notifies PopupMenuListeners that the popup portion of the combo box has become invisible. |
void |
firePopupMenuWillBecomeVisible() |
Notifies PopupMenuListeners that the popup portion of the combo box will become visible. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JComboBox. |
Action |
getAction() |
Returns the currently set Action for this ActionEvent source, or null if no Action is set. |
String |
getActionCommand() |
Returns the action command that is included in the event sent to action listeners. |
ActionListener[] |
getActionListeners() |
Returns an array of all the ActionListeners added to this JComboBox with addActionListener(). |
ComboBoxEditor |
getEditor() |
Returns the editor used to paint and edit the selected item in the JComboBox field. |
E |
getItemAt |
Returns the list item at the specified index. |
int |
getItemCount() |
Returns the number of items in the list. |
ItemListener[] |
getItemListeners() |
Returns an array of all the ItemListeners added to this JComboBox with addItemListener(). |
JComboBox.KeySelectionManager |
getKeySelectionManager() |
Returns the list's key-selection manager. |
int |
getMaximumRowCount() |
Returns the maximum number of items the combo box can display without a scrollbar |
ComboBoxModel |
getModel() |
Returns the data model currently used by the JComboBox. |
PopupMenuListener[] |
getPopupMenuListeners() |
Returns an array of all the PopupMenuListeners added to this JComboBox with addPopupMenuListener(). |
E |
getPrototypeDisplayValue() |
Returns the "prototypical display" value - an Object used for the calculation of the display height and width. |
ListCellRenderer |
getRenderer() |
Returns the renderer used to display the selected item in the JComboBox field. |
int |
getSelectedIndex() |
Returns the first item in the list that matches the given item. |
Object |
getSelectedItem() |
Returns the current selected item. |
Object[] |
getSelectedObjects() |
Returns an array containing the selected item. |
ComboBoxUI |
getUI() |
Returns the L&F object that renders this component. |
String |
getUIClassID() |
Returns the name of the L&F class that renders this component. |
void |
hidePopup() |
Causes the combo box to close its popup window. |
void |
insertItemAt |
Inserts an item into the item list at a given index. |
protected void |
installAncestorListener() |
Registers ancestor listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible. |
void |
intervalAdded |
This method is public as an implementation side effect. do not call or override. |
void |
intervalRemoved |
This method is public as an implementation side effect. do not call or override. |
boolean |
isEditable() |
Returns true if the JComboBox is editable. |
boolean |
isLightWeightPopupEnabled() |
Gets the value of the lightWeightPopupEnabled property. |
boolean |
isPopupVisible() |
Determines the visibility of the popup. |
protected String |
paramString() |
Returns a string representation of this JComboBox. |
void |
processKeyEvent |
Handles KeyEvents, looking for the Tab key. |
void |
removeActionListener |
Removes an ActionListener. |
void |
removeAllItems() |
Removes all items from the item list. |
void |
removeItem |
Removes an item from the item list. |
void |
removeItemAt |
Removes the item at anIndex This method works only if the JComboBox uses a mutable data model. |
void |
removeItemListener |
Removes an ItemListener. |
void |
removePopupMenuListener |
Removes a PopupMenuListener. |
protected void |
selectedItemChanged() |
This protected method is implementation specific. |
boolean |
selectWithKeyChar |
Selects the list item that corresponds to the specified keyboard character and returns true, if there is an item corresponding to that character. |
void |
setAction |
Sets the Action for the ActionEvent source. |
void |
setActionCommand |
Sets the action command that should be included in the event sent to action listeners. |
void |
setEditable |
Determines whether the JComboBox field is editable. |
void |
setEditor |
Sets the editor used to paint and edit the selected item in the JComboBox field. |
void |
setEnabled |
Enables the combo box so that items can be selected. |
void |
setKeySelectionManager |
Sets the object that translates a keyboard character into a list selection. |
void |
setLightWeightPopupEnabled |
Sets the lightWeightPopupEnabled property, which provides a hint as to whether or not a lightweight Component should be used to contain the JComboBox, versus a heavyweight Component such as a Panel or a Window. |
void |
setMaximumRowCount |
Sets the maximum number of rows the JComboBox displays. |
void |
setModel |
Sets the data model that the JComboBox uses to obtain the list of items. |
void |
setPopupVisible |
Sets the visibility of the popup. |
void |
setPrototypeDisplayValue |
Sets the prototype display value used to calculate the size of the display for the UI portion. |
void |
setRenderer |
Sets the renderer that paints the list items and the item selected from the list in the JComboBox field. |
void |
setSelectedIndex |
Selects the item at index anIndex. |
void |
setSelectedItem |
Sets the selected item in the combo box display area to the object in the argument. |
void |
setUI |
Sets the L&F object that renders this component. |
void |
showPopup() |
Causes the combo box to display its popup window. |
void |
updateUI() |
Resets the UI property to a value from the current look and feel. |
Methods declared in class JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update | Modifier and Type | Method | Description |
|---|---|---|
void |
addAncestorListener |
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 |
addVetoableChangeListener |
Adds a VetoableChangeListener to the listener list. |
void |
computeVisibleRect |
Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors. |
boolean |
contains |
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. |
void |
enable() |
Deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). |
void |
firePropertyChange |
Support for reporting bound property changes for boolean properties. |
void |
firePropertyChange |
Support for reporting bound property changes for integer properties. |
protected void |
fireVetoableChange |
Supports reporting constrained property changes. |
ActionListener |
getActionForKeyStroke |
Returns the object that will perform the action registered for a given keystroke. |
final ActionMap |
getActionMap() |
Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding. |
float |
getAlignmentX() |
Overrides Container.getAlignmentX to return the horizontal alignment. |
float |
getAlignmentY() |
Overrides Container.getAlignmentY to return the vertical alignment. |
AncestorListener[] |
getAncestorListeners() |
Returns an array of all the ancestor listeners registered on this component. |
boolean |
getAutoscrolls() |
Gets the autoscrolls property. |
int |
getBaseline |
Returns the baseline. |
Component.BaselineResizeBehavior |
getBaselineResizeBehavior() |
Returns an enum indicating how the baseline of the component changes as the size changes. |
Border |
getBorder() |
Returns the border of this component or null if no border is currently set. |
Rectangle |
getBounds |
Stores the bounds of this component into "return value" rv and returns rv. |
final Object |
getClientProperty |
Returns the value of the property with the specified key. |
protected Graphics |
getComponentGraphics |
Returns the graphics object used to paint this component. |
JPopupMenu |
getComponentPopupMenu() |
Returns JPopupMenu that assigned for this component. |
int |
getConditionForKeyStroke |
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 |
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. |
final InputMap |
getInputMap() |
Returns the InputMap that is used when the component has focus. |
final InputMap |
getInputMap |
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 |
Returns an Insets object containing this component's inset values. |
<T extends EventListener> |
getListeners |
Returns an array of all the objects currently registered as FooListeners upon this JComponent. |
Point |
getLocation |
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 |
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. |
KeyStroke[] |
getRegisteredKeyStrokes() |
Returns the KeyStrokes that will initiate registered actions. |
JRootPane |
getRootPane() |
Returns the JRootPane ancestor for this component. |
Dimension |
getSize |
Stores the width/height of this component into "return value" rv and returns rv. |
Point |
getToolTipLocation |
Returns the tooltip location in this component's coordinate system. |
String |
getToolTipText() |
Returns the tooltip string that has been set with setToolTipText. |
String |
getToolTipText |
Returns the string to be used as the tooltip for event. |
Container |
getTopLevelAncestor() |
Returns the top-level ancestor of this component (the containing Window) or null if this component has not been added to any container. |
TransferHandler |
getTransferHandler() |
Gets the transferHandler property. |
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. |
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. |
void |
hide() |
Deprecated. |
boolean |
isDoubleBuffered() |
Returns whether this component should use a buffer to paint. |
static boolean |
isLightweightComponent |
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 |
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. |
final boolean |
isPaintingForPrint() |
Returns true if the current painting operation on this component is part of a print operation. |
protected boolean |
isPaintingOrigin() |
Returns true if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors. |
boolean |
isPaintingTile() |
Returns true if the component is currently painting a tile. |
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 |
Invoked by Swing to draw components. |
protected void |
paintBorder |
Paints the component's border. |
protected void |
paintChildren |
Paints this component's children. |
protected void |
paintComponent |
Calls the UI delegate's paint method, if the UI delegate is non- null. |
void |
paintImmediately |
Paints the specified region in this component and all of its descendants that overlap the region, immediately. |
void |
paintImmediately |
Paints the specified region now. |
void |
print |
Invoke this method to print the component to the specified Graphics. |
void |
printAll |
Invoke this method to print the component. |
protected void |
printBorder |
Prints the component's border. |
protected void |
printChildren |
Prints this component's children. |
protected void |
printComponent |
This is invoked during a printing operation. |
protected void |
processComponentKeyEvent |
Processes any key events that the component itself recognizes. |
protected boolean |
processKeyBinding |
Invoked to process the key bindings for ks as the result of the KeyEvent e. |
protected void |
processMouseEvent |
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. |
protected void |
processMouseMotionEvent |
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED. |
final void |
putClientProperty |
Adds an arbitrary key/value "client property" to this component. |
void |
registerKeyboardAction |
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior. |
void |
registerKeyboardAction |
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior. |
void |
removeAncestorListener |
Unregisters listener so that it will no longer receive AncestorEvents. |
void |
removeNotify() |
Notifies this component that it no longer has a parent component. |
void |
removeVetoableChangeListener |
Removes a VetoableChangeListener from the listener list. |
void |
repaint |
Adds the specified region to the dirty region list if the component is showing. |
void |
repaint |
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 the input focus. |
boolean |
requestFocus |
Requests that this Component gets the input focus. |
boolean |
requestFocusInWindow() |
Requests that this Component gets the input focus. |
protected boolean |
requestFocusInWindow |
Requests that this Component gets the input focus. |
void |
resetKeyboardActions() |
Unregisters all the bindings in the first tier InputMaps and ActionMap. |
void |
reshape |
Deprecated. As of JDK 5, replaced by Component.setBounds(int, int, int, int). |
void |
revalidate() |
Supports deferred automatic layout. |
void |
scrollRectToVisible |
Forwards the scrollRectToVisible() message to the JComponent's parent. |
final void |
setActionMap |
Sets the ActionMap to am. |
void |
setAlignmentX |
Sets the horizontal alignment. |
void |
setAlignmentY |
Sets the vertical alignment. |
void |
setAutoscrolls |
Sets the autoscrolls property. |
void |
setBackground |
Sets the background color of this component. |
void |
setBorder |
Sets the border of this component. |
void |
setComponentPopupMenu |
Sets the JPopupMenu for this JComponent. |
void |
setDebugGraphicsOptions |
Enables or disables diagnostic information about every graphics operation performed within the component or one of its children. |
static void |
setDefaultLocale |
Sets the default locale used to initialize each JComponent's locale property upon creation. |
void |
setDoubleBuffered |
Sets whether this component should use a buffer to paint. |
void |
setFocusTraversalKeys |
Sets the focus traversal keys for a given traversal operation for this Component. |
void |
setFont |
Sets the font for this component. |
void |
setForeground |
Sets the foreground color of this component. |
void |
setInheritsPopupMenu |
Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it. |
final void |
setInputMap |
Sets the InputMap to use under the condition condition to map. |
void |
setInputVerifier |
Sets the input verifier for this component. |
void |
setMaximumSize |
Sets the maximum size of this component to a constant value. |
void |
setMinimumSize |
Sets the minimum size of this component to a constant value. |
void |
setNextFocusableComponent |
Deprecated. As of 1.4, replaced by FocusTraversalPolicy
|
void |
setOpaque |
If true the component paints every pixel within its bounds. |
void |
setPreferredSize |
Sets the preferred size of this component. |
void |
setRequestFocusEnabled |
Provides a hint as to whether or not this JComponent should get focus. |
void |
setToolTipText |
Registers the text to display in a tool tip. |
void |
setTransferHandler |
Sets the TransferHandler, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop. |
protected void |
setUI |
Sets the look and feel delegate for this component. |
void |
setVerifyInputWhenFocusTarget |
Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. |
void |
setVisible |
Makes the component visible or invisible. |
void |
unregisterKeyboardAction |
This method is now obsolete. |
void |
update |
Calls paint. |
Methods declared in class Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree | Modifier and Type | Method | Description |
|---|---|---|
Component |
add |
Appends the specified component to the end of this container. |
Component |
add |
Adds the specified component to this container at the given position. |
void |
add |
Adds the specified component to the end of this container. |
void |
add |
Adds the specified component to this container with the specified constraints at the specified index. |
Component |
add |
Adds the specified component to this container. |
void |
addContainerListener |
Adds the specified container listener to receive container events from this container. |
protected void |
addImpl |
Adds the specified component to this container at the specified index. |
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list. |
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list for a specific property. |
void |
applyComponentOrientation |
Sets the ComponentOrientation property of this container and all components contained within it. |
boolean |
areFocusTraversalKeysSet |
Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container. |
int |
countComponents() |
Deprecated. As of JDK version 1.1, replaced by getComponentCount(). |
void |
deliverEvent |
Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e)
|
void |
doLayout() |
Causes this container to lay out its components. |
Component |
findComponentAt |
Locates the visible child component that contains the specified position. |
Component |
findComponentAt |
Locates the visible child component that contains the specified point. |
Component |
getComponent |
Gets the nth component in this container. |
Component |
getComponentAt |
Locates the component that contains the x,y position. |
Component |
getComponentAt |
Gets the component that contains the specified point. |
int |
getComponentCount() |
Gets the number of components in this panel. |
Component[] |
getComponents() |
Gets all the components in this container. |
int |
getComponentZOrder |
Returns the z-order index of the component inside the container. |
ContainerListener[] |
getContainerListeners() |
Returns an array of all the container listeners registered on this container. |
Set |
getFocusTraversalKeys |
Returns the Set of focus traversal keys for a given traversal operation for this Container. |
FocusTraversalPolicy |
getFocusTraversalPolicy() |
Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root. |
LayoutManager |
getLayout() |
Gets the layout manager for this container. |
Point |
getMousePosition |
Returns the position of the mouse pointer in this Container's coordinate space if the Container is under the mouse pointer, otherwise returns null. |
Insets |
insets() |
Deprecated. As of JDK version 1.1, replaced by getInsets(). |
void |
invalidate() |
Invalidates the container. |
boolean |
isAncestorOf |
Checks if the component is contained in the component hierarchy of this container. |
boolean |
isFocusCycleRoot() |
Returns whether this Container is the root of a focus traversal cycle. |
boolean |
isFocusCycleRoot |
Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle. |
final boolean |
isFocusTraversalPolicyProvider() |
Returns whether this container provides focus traversal policy. |
boolean |
isFocusTraversalPolicySet() |
Returns whether the focus traversal policy has been explicitly set for this Container. |
void |
layout() |
Deprecated. As of JDK version 1.1, replaced by doLayout(). |
void |
list |
Prints a listing of this container to the specified output stream. |
void |
list |
Prints out a list, starting at the specified indentation, to the specified print writer. |
Component |
locate |
Deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int). |
Dimension |
minimumSize() |
Deprecated. As of JDK version 1.1, replaced by getMinimumSize(). |
void |
paintComponents |
Paints each of the components in this container. |
Dimension |
preferredSize() |
Deprecated. As of JDK version 1.1, replaced by getPreferredSize(). |
void |
printComponents |
Prints each of the components in this container. |
protected void |
processContainerEvent |
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects. |
protected void |
processEvent |
Processes events on this container. |
void |
remove |
Removes the component, specified by index, from this container. |
void |
remove |
Removes the specified component from this container. |
void |
removeAll() |
Removes all the components from this container. |
void |
removeContainerListener |
Removes the specified container listener so it no longer receives container events from this container. |
void |
setComponentZOrder |
Moves the specified component to the specified z-order index in the container. |
void |
setFocusCycleRoot |
Sets whether this Container is the root of a focus traversal cycle. |
void |
setFocusTraversalPolicy |
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root. |
final void |
setFocusTraversalPolicyProvider |
Sets whether this container will be used to provide focus traversal policy. |
void |
setLayout |
Sets the layout manager for this container. |
void |
transferFocusDownCycle() |
Transfers the focus down one focus traversal cycle. |
void |
validate() |
Validates this container and all of its subcomponents. |
protected void |
validateTree() |
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid). |
Methods declared in class 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, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle | Modifier and Type | Method | Description |
|---|---|---|
boolean |
action |
Deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events. |
void |
add |
Adds the specified popup menu to the component. |
void |
addComponentListener |
Adds the specified component listener to receive component events from this component. |
void |
addFocusListener |
Adds the specified focus listener to receive focus events from this component when this component gains input focus. |
void |
addHierarchyBoundsListener |
Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes. |
void |
addHierarchyListener |
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes. |
void |
addInputMethodListener |
Adds the specified input method listener to receive input method events from this component. |
void |
addKeyListener |
Adds the specified key listener to receive key events from this component. |
void |
addMouseListener |
Adds the specified mouse listener to receive mouse events from this component. |
void |
addMouseMotionListener |
Adds the specified mouse motion listener to receive mouse motion events from this component. |
void |
addMouseWheelListener |
Adds the specified mouse wheel listener to receive mouse wheel events from this component. |
Rectangle |
bounds() |
Deprecated. As of JDK version 1.1, replaced by getBounds(). |
int |
checkImage |
Returns the status of the construction of a screen representation of the specified image. |
int |
checkImage |
Returns the status of the construction of a screen representation of the specified image. |
protected AWTEvent |
coalesceEvents |
Potentially coalesce an event being posted with an existing event. |
boolean |
contains |
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component. |
Image |
createImage |
Creates an off-screen drawable image to be used for double buffering. |
Image |
createImage |
Creates an image from the specified image producer. |
VolatileImage |
createVolatileImage |
Creates a volatile off-screen drawable image to be used for double buffering. |
VolatileImage |
createVolatileImage |
Creates a volatile off-screen drawable image, with the given capabilities. |
protected final void |
disableEvents |
Disables the events defined by the specified event mask parameter from being delivered to this component. |
final void |
dispatchEvent |
Dispatches an event to this component or one of its sub components. |
void |
enable |
Deprecated. As of JDK version 1.1, replaced by setEnabled(boolean). |
protected final void |
enableEvents |
Enables the events defined by the specified event mask parameter to be delivered to this component. |
void |
enableInputMethods |
Enables or disables input method support for this component. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
protected void |
firePropertyChange |
Support for reporting bound property changes for Object properties. |
Color |
getBackground() |
Gets the background color of this component. |
Rectangle |
getBounds() |
Gets the bounds of this component in the form of a Rectangle object. |
ColorModel |
getColorModel() |
Gets the instance of ColorModel used to display the component on the output device. |
ComponentListener[] |
getComponentListeners() |
Returns an array of all the component listeners registered on this component. |
ComponentOrientation |
getComponentOrientation() |
Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component. |
Cursor |
getCursor() |
Gets the cursor set in the component. |
DropTarget |
getDropTarget() |
Gets the DropTarget associated with this Component. |
Container |
getFocusCycleRootAncestor() |
Returns the Container which is the focus cycle root of this Component's focus traversal cycle. |
FocusListener[] |
getFocusListeners() |
Returns an array of all the focus listeners registered on this component. |
boolean |
getFocusTraversalKeysEnabled() |
Returns whether focus traversal keys are enabled for this Component. |
Font |
getFont() |
Gets the font of this component. |
Color |
getForeground() |
Gets the foreground color of this component. |
GraphicsConfiguration |
getGraphicsConfiguration() |
Gets the GraphicsConfiguration associated with this Component. |
HierarchyBoundsListener[] |
getHierarchyBoundsListeners() |
Returns an array of all the hierarchy bounds listeners registered on this component. |
HierarchyListener[] |
getHierarchyListeners() |
Returns an array of all the hierarchy listeners registered on this component. |
boolean |
getIgnoreRepaint() |
Returns whether or not paint messages received from the operating system should be ignored. |
InputContext |
getInputContext() |
Gets the input context used by this component for handling the communication with input methods when text is entered in this component. |
InputMethodListener[] |
getInputMethodListeners() |
Returns an array of all the input method listeners registered on this component. |
InputMethodRequests |
getInputMethodRequests() |
Gets the input method request handler which supports requests from input methods for this component. |
KeyListener[] |
getKeyListeners() |
Returns an array of all the key listeners registered on this component. |
Locale |
getLocale() |
Gets the locale of this component. |
Point |
getLocation() |
Gets the location of this component in the form of a point specifying the component's top-left corner. |
Point |
getLocationOnScreen() |
Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space. |
MouseListener[] |
getMouseListeners() |
Returns an array of all the mouse listeners registered on this component. |
MouseMotionListener[] |
getMouseMotionListeners() |
Returns an array of all the mouse motion listeners registered on this component. |
Point |
getMousePosition() |
Returns the position of the mouse pointer in this Component's coordinate space if the Component is directly under the mouse pointer, otherwise returns null. |
MouseWheelListener[] |
getMouseWheelListeners() |
Returns an array of all the mouse wheel listeners registered on this component. |
String |
getName() |
Gets the name of the component. |
Container |
getParent() |
Gets the parent of this component. |
PropertyChangeListener[] |
getPropertyChangeListeners() |
Returns an array of all the property change listeners registered on this component. |
PropertyChangeListener[] |
getPropertyChangeListeners |
Returns an array of all the listeners which have been associated with the named property. |
Dimension |
getSize() |
Returns the size of this component in the form of a Dimension object. |
Toolkit |
getToolkit() |
Gets the toolkit of this component. |
final Object |
getTreeLock() |
Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations. |
boolean |
gotFocus |
Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). |
boolean |
handleEvent |
Deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent). |
boolean |
hasFocus() |
Returns true if this Component is the focus owner. |
boolean |
imageUpdate |
Repaints the component when the image has changed. |
boolean |
inside |
Deprecated. As of JDK version 1.1, replaced by contains(int, int). |
boolean |
isBackgroundSet() |
Returns whether the background color has been explicitly set for this Component. |
boolean |
isCursorSet() |
Returns whether the cursor has been explicitly set for this Component. |
boolean |
isDisplayable() |
Determines whether this component is displayable. |
boolean |
isEnabled() |
Determines whether this component is enabled. |
boolean |
isFocusable() |
Returns whether this Component can be focused. |
boolean |
isFocusOwner() |
Returns true if this Component is the focus owner. |
boolean |
isFocusTraversable() |
Deprecated. As of 1.4, replaced by isFocusable(). |
boolean |
isFontSet() |
Returns whether the font has been explicitly set for this Component. |
boolean |
isForegroundSet() |
Returns whether the foreground color has been explicitly set for this Component. |
boolean |
isLightweight() |
A lightweight component doesn't have a native toolkit peer. |
boolean |
isMaximumSizeSet() |
Returns true if the maximum size has been set to a non- null value otherwise returns false. |
boolean |
isMinimumSizeSet() |
Returns whether or not setMinimumSize has been invoked with a non-null value. |
boolean |
isPreferredSizeSet() |
Returns true if the preferred size has been set to a non- null value otherwise returns false. |
boolean |
isShowing() |
Determines whether this component is showing on screen. |
boolean |
isValid() |
Determines whether this component is valid. |
boolean |
isVisible() |
Determines whether this component should be visible when its parent is visible. |
boolean |
keyDown |
Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). |
boolean |
keyUp |
Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). |
void |
list() |
Prints a listing of this component to the standard system output stream System.out. |
void |
list |
Prints a listing of this component to the specified output stream. |
void |
list |
Prints a listing to the specified print writer. |
Point |
location() |
Deprecated. As of JDK version 1.1, replaced by getLocation(). |
boolean |
lostFocus |
Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). |
boolean |
mouseDown |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseDrag |
Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). |
boolean |
mouseEnter |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseExit |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseMove |
Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). |
boolean |
mouseUp |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
void |
move |
Deprecated. As of JDK version 1.1, replaced by setLocation(int, int). |
void |
nextFocus() |
Deprecated. As of JDK version 1.1, replaced by transferFocus(). |
void |
paintAll |
Paints this component and all of its subcomponents. |
boolean |
postEvent |
Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent). |
boolean |
prepareImage |
Prepares an image for rendering on this component at the specified width and height. |
boolean |
prepareImage |
Prepares an image for rendering on this component. |
protected void |
processComponentEvent |
Processes component events occurring on this component by dispatching them to any registered ComponentListener objects. |
protected void |
processFocusEvent |
Processes focus events occurring on this component by dispatching them to any registered FocusListener objects. |
protected void |
processHierarchyBoundsEvent |
Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects. |
protected void |
processHierarchyEvent |
Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects. |
protected void |
processInputMethodEvent |
Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects. |
protected void |
processMouseWheelEvent |
Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects. |
void |
remove |
Removes the specified popup menu from the component. |
void |
removeComponentListener |
Removes the specified component listener so that it no longer receives component events from this component. |
void |
removeFocusListener |
Removes the specified focus listener so that it no longer receives focus events from this component. |
void |
removeHierarchyBoundsListener |
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component. |
void |
removeHierarchyListener |
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component. |
void |
removeInputMethodListener |
Removes the specified input method listener so that it no longer receives input method events from this component. |
void |
removeKeyListener |
Removes the specified key listener so that it no longer receives key events from this component. |
void |
removeMouseListener |
Removes the specified mouse listener so that it no longer receives mouse events from this component. |
void |
removeMouseMotionListener |
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component. |
void |
removeMouseWheelListener |
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list for a specific property. |
void |
repaint() |
Repaints this component. |
void |
repaint |
Repaints the specified rectangle of this component. |
void |
repaint |
Repaints the component. |
protected boolean |
requestFocus |
Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
void |
requestFocus |
Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
boolean |
requestFocusInWindow |
Requests by the reason of cause that this Component get the input focus, if this Component's top-level ancestor is already the focused Window. |
void |
resize |
Deprecated. As of JDK version 1.1, replaced by setSize(int, int). |
void |
resize |
Deprecated. As of JDK version 1.1, replaced by setSize(Dimension). |
void |
setBounds |
Moves and resizes this component. |
void |
setBounds |
Moves and resizes this component to conform to the new bounding rectangle r. |
void |
setComponentOrientation |
Sets the language-sensitive orientation that is to be used to order the elements or text within this component. |
void |
setCursor |
Sets the cursor image to the specified cursor. |
void |
setDropTarget |
Associate a DropTarget with this component. |
void |
setFocusable |
Sets the focusable state of this Component to the specified value. |
void |
setFocusTraversalKeysEnabled |
Sets whether focus traversal keys are enabled for this Component. |
void |
setIgnoreRepaint |
Sets whether or not paint messages received from the operating system should be ignored. |
void |
setLocale |
Sets the locale of this component. |
void |
setLocation |
Moves this component to a new location. |
void |
setLocation |
Moves this component to a new location. |
void |
setMixingCutoutShape |
Sets a 'mixing-cutout' shape for this lightweight component. |
void |
setName |
Sets the name of the component to the specified string. |
void |
setSize |
Resizes this component so that it has width width and height height. |
void |
setSize |
Resizes this component so that it has width d.width and height d.height. |
void |
show() |
Deprecated. As of JDK version 1.1, replaced by setVisible(boolean). |
void |
show |
Deprecated. As of JDK version 1.1, replaced by setVisible(boolean). |
Dimension |
size() |
Deprecated. As of JDK version 1.1, replaced by getSize(). |
String |
toString() |
Returns a string representation of this component and its values. |
void |
transferFocus() |
Transfers the focus to the next component, as though this Component were the focus owner. |
void |
transferFocusBackward() |
Transfers the focus to the previous component, as though this Component were the focus owner. |
void |
transferFocusUpCycle() |
Transfers the focus up one focus traversal cycle. |
Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected Object |
clone() |
Creates and returns a copy of this object. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
int |
hashCode() |
Returns a hash code value for this object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Field Details
dataModel
protected ComboBoxModel<E> dataModel
- See Also:
renderer
protected ListCellRenderer<? super E> renderer
- See Also:
editor
protected ComboBoxEditor editor
- See Also:
maximumRowCount
protected int maximumRowCount
- See Also:
isEditable
protected boolean isEditable
- See Also:
keySelectionManager
protected JComboBox.KeySelectionManager keySelectionManager
- See Also:
actionCommand
protected String actionCommand
- See Also:
lightWeightPopupEnabled
protected boolean lightWeightPopupEnabled
- See Also:
selectedItemReminder
protected Object selectedItemReminder
Constructor Details
JComboBox
public JComboBox(ComboBoxModel<E> aModel)
JComboBox that takes its items from an existing ComboBoxModel. Since the ComboBoxModel is provided, a combo box created using this constructor does not create a default combo box model and may impact how the insert, remove and add methods behave.- Parameters:
-
aModel- theComboBoxModelthat provides the displayed list of items - See Also:
JComboBox
public JComboBox(E[] items)
JComboBox that contains the elements in the specified array. By default the first item in the array (and therefore the data model) becomes selected.- Parameters:
-
items- an array of objects to insert into the combo box - See Also:
JComboBox
public JComboBox(Vector<E> items)
JComboBox that contains the elements in the specified Vector. By default the first item in the vector (and therefore the data model) becomes selected.- Parameters:
-
items- an array of vectors to insert into the combo box - See Also:
JComboBox
public JComboBox()
JComboBox with a default data model. The default data model is an empty list of objects. Use addItem to add items. By default the first item in the data model becomes selected.- See Also:
Method Details
installAncestorListener
protected void installAncestorListener()
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.setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component's LookAndFeel.") public void setUI(ComboBoxUI ui)
- Parameters:
-
ui- theComboBoxUIL&F object - See Also:
updateUI
public void updateUI()
- Overrides:
-
updateUIin classJComponent - See Also:
getUIClassID
@BeanProperty(bound=false) public String getUIClassID()
- Overrides:
-
getUIClassIDin classJComponent - Returns:
- the string "ComboBoxUI"
- See Also:
getUI
public ComboBoxUI getUI()
- Overrides:
-
getUIin classJComponent - Returns:
- the ComboBoxUI object that renders this component
setModel
@BeanProperty(description="Model that the combo box uses to get data to display.") public void setModel(ComboBoxModel<E> aModel)
JComboBox uses to obtain the list of items.- Parameters:
-
aModel- theComboBoxModelthat provides the displayed list of items
getModel
public ComboBoxModel<E> getModel()
JComboBox.- Returns:
- the
ComboBoxModelthat provides the displayed list of items
setLightWeightPopupEnabled
@BeanProperty(expert=true, description="Set to <code>false</code> to require heavyweight popups.") public void setLightWeightPopupEnabled(boolean aFlag)
lightWeightPopupEnabled property, which provides a hint as to whether or not a lightweight Component should be used to contain the JComboBox, versus a heavyweight Component such as a Panel or a Window. The decision of lightweight versus heavyweight is ultimately up to the JComboBox. Lightweight windows are more efficient than heavyweight windows, but lightweight and heavyweight components do not mix well in a GUI. If your application mixes lightweight and heavyweight components, you should disable lightweight popups. The default value for the lightWeightPopupEnabled property is true, unless otherwise specified by the look and feel. Some look and feels always use heavyweight popups, no matter what the value of this property. See the article Mixing Heavy and Light Components This method fires a property changed event.
- Parameters:
-
aFlag- iftrue, lightweight popups are desired
isLightWeightPopupEnabled
public boolean isLightWeightPopupEnabled()
lightWeightPopupEnabled property.- Returns:
- the value of the
lightWeightPopupEnabledproperty - See Also:
setEditable
@BeanProperty(preferred=true, description="If true, the user can type a new value in the combo box.") public void setEditable(boolean aFlag)
JComboBox field is editable. An editable JComboBox allows the user to type into the field or selected an item from the list to initialize the field, after which it can be edited. (The editing affects only the field, the list item remains intact.) A non editable JComboBox displays the selected item in the field, but the selection cannot be modified.- Parameters:
-
aFlag- a boolean value, where true indicates that the field is editable
isEditable
public boolean isEditable()
JComboBox is editable. By default, a combo box is not editable.- Returns:
- true if the
JComboBoxis editable, else false
setMaximumRowCount
@BeanProperty(preferred=true, description="The maximum number of rows the popup should have") public void setMaximumRowCount(int count)
JComboBox displays. If the number of objects in the model is greater than count, the combo box uses a scrollbar.- Parameters:
-
count- an integer specifying the maximum number of items to display in the list before using a scrollbar
getMaximumRowCount
public int getMaximumRowCount()
- Returns:
- an integer specifying the maximum number of items that are displayed in the list before using a scrollbar
setRenderer
@BeanProperty(expert=true, description="The renderer that paints the item selected in the list.") public void setRenderer(ListCellRenderer<? super E> aRenderer)
The default renderer displays a string or an icon. Other renderers can handle graphic images and composite items.
To display the selected item, aRenderer.getListCellRendererComponent is called, passing the list object and an index of -1.
- Parameters:
-
aRenderer- theListCellRendererthat displays the selected item - See Also:
getRenderer
public ListCellRenderer<? super E> getRenderer()
JComboBox field.- Returns:
- the
ListCellRendererthat displays the selected item.
setEditor
@BeanProperty(expert=true, description="The editor that combo box uses to edit the current value") public void setEditor(ComboBoxEditor anEditor)
JComboBox field. The editor is used only if the receiving JComboBox is editable. If not editable, the combo box uses the renderer to paint the selected item.- Parameters:
-
anEditor- theComboBoxEditorthat displays the selected item - See Also:
getEditor
public ComboBoxEditor getEditor()
JComboBox field.- Returns:
- the
ComboBoxEditorthat displays the selected item
setSelectedItem
@BeanProperty(bound=false, preferred=true, description="Sets the selected item in the JComboBox.") public void setSelectedItem(Object anObject)
anObject is in the list, the display area shows anObject selected. If anObject is not in the list and the combo box is uneditable, it will not change the current selection. For editable combo boxes, the selection will change to anObject.
If this constitutes a change in the selected item, ItemListeners added to the combo box will be notified with one or two ItemEvents. If there is a current selected item, an ItemEvent will be fired and the state change will be ItemEvent.DESELECTED. If anObject is in the list and is not currently selected then an ItemEvent will be fired and the state change will be ItemEvent.SELECTED.
ActionListeners added to the combo box will be notified with an ActionEvent when this method is called.
- Parameters:
-
anObject- the list object to select; usenullto clear the selection
getSelectedItem
public Object getSelectedItem()
If the combo box is editable, then this value may not have been added to the combo box with addItem, insertItemAt or the data constructors.
- Returns:
- the current selected Object
- See Also:
setSelectedIndex
@BeanProperty(bound=false, preferred=true, description="The item at index is selected.") public void setSelectedIndex(int anIndex)
anIndex.- Parameters:
-
anIndex- an integer specifying the list item to select, where 0 specifies the first item in the list and -1 indicates no selection - Throws:
-
IllegalArgumentException- ifanIndex< -1 oranIndexis greater than or equal to size
getSelectedIndex
public int getSelectedIndex()
JComboBox allows selected items that are not in the list. Returns -1 if there is no selected item or if the user specified an item which is not in the list.- Returns:
- an integer specifying the currently selected list item, where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list
getPrototypeDisplayValue
public E getPrototypeDisplayValue()
- Returns:
- the value of the
prototypeDisplayValueproperty - Since:
- 1.4
- See Also:
setPrototypeDisplayValue
@BeanProperty(visualUpdate=true, description="The display prototype value, used to compute display width and height.") public void setPrototypeDisplayValue(E prototypeDisplayValue)
If a prototype display value is specified, the preferred size of the combo box is calculated by configuring the renderer with the prototype display value and obtaining its preferred size. Specifying the preferred display value is often useful when the combo box will be displaying large amounts of data. If no prototype display value has been specified, the renderer must be configured for each value from the model and its preferred size obtained, which can be relatively expensive.
- Parameters:
-
prototypeDisplayValue- the prototype display value - Since:
- 1.4
- See Also:
addItem
public void addItem(E item)
JComboBox uses a mutable data model. Warning: Focus and keyboard navigation problems may arise if you add duplicate String objects. A workaround is to add new objects instead of String objects and make sure that the toString() method is defined. For example:
comboBox.addItem(makeObj("Item 1"));
comboBox.addItem(makeObj("Item 1"));
...
private Object makeObj(final String item) {
return new Object() { public String toString() { return item; } };
}
- Parameters:
-
item- the item to add to the list - See Also:
insertItemAt
public void insertItemAt(E item, int index)
JComboBox uses a mutable data model.- Parameters:
-
item- the item to add to the list -
index- an integer specifying the position at which to add the item - See Also:
removeItem
public void removeItem(Object anObject)
JComboBox uses a mutable data model.- Parameters:
-
anObject- the object to remove from the item list - See Also:
removeItemAt
public void removeItemAt(int anIndex)
anIndex This method works only if the JComboBox uses a mutable data model.- Parameters:
-
anIndex- an int specifying the index of the item to remove, where 0 indicates the first item in the list - See Also:
removeAllItems
public void removeAllItems()
showPopup
public void showPopup()
- See Also:
hidePopup
public void hidePopup()
- See Also:
setPopupVisible
public void setPopupVisible(boolean v)
- Parameters:
-
v- iftrueshows the popup, otherwise, hides the popup.
isPopupVisible
public boolean isPopupVisible()
- Returns:
- true if the popup is visible, otherwise returns false
addItemListener
public void addItemListener(ItemListener aListener)
ItemListener. aListener will receive one or two ItemEvents when the selected item changes.
- Specified by:
-
addItemListenerin interfaceItemSelectable - Parameters:
-
aListener- theItemListenerthat is to be notified - See Also:
removeItemListener
public void removeItemListener(ItemListener aListener)
ItemListener.- Specified by:
-
removeItemListenerin interfaceItemSelectable - Parameters:
-
aListener- theItemListenerto remove - See Also:
getItemListeners
@BeanProperty(bound=false) public ItemListener[] getItemListeners()
ItemListeners added to this JComboBox with addItemListener().- Returns:
- all of the
ItemListeners added or an empty array if no listeners have been added - Since:
- 1.4
addActionListener
public void addActionListener(ActionListener l)
ActionListener. The ActionListener will receive an ActionEvent when a selection has been made. If the combo box is editable, then an ActionEvent will be fired when editing has stopped.
- Parameters:
-
l- theActionListenerthat is to be notified - See Also:
removeActionListener
public void removeActionListener(ActionListener l)
ActionListener.- Parameters:
-
l- theActionListenerto remove
getActionListeners
@BeanProperty(bound=false) public ActionListener[] getActionListeners()
ActionListeners added to this JComboBox with addActionListener().- Returns:
- all of the
ActionListeners added or an empty array if no listeners have been added - Since:
- 1.4
addPopupMenuListener
public void addPopupMenuListener(PopupMenuListener l)
PopupMenu listener which will listen to notification messages from the popup portion of the combo box. For all standard look and feels shipped with Java, the popup list portion of combo box is implemented as a JPopupMenu. A custom look and feel may not implement it this way and will therefore not receive the notification.
- Parameters:
-
l- thePopupMenuListenerto add - Since:
- 1.4
removePopupMenuListener
public void removePopupMenuListener(PopupMenuListener l)
PopupMenuListener.- Parameters:
-
l- thePopupMenuListenerto remove - Since:
- 1.4
- See Also:
getPopupMenuListeners
@BeanProperty(bound=false) public PopupMenuListener[] getPopupMenuListeners()
PopupMenuListeners added to this JComboBox with addPopupMenuListener().- Returns:
- all of the
PopupMenuListeners added or an empty array if no listeners have been added - Since:
- 1.4
firePopupMenuWillBecomeVisible
public void firePopupMenuWillBecomeVisible()
PopupMenuListeners that the popup portion of the combo box will become visible. This method is public but should not be called by anything other than the UI delegate.
- Since:
- 1.4
- See Also:
firePopupMenuWillBecomeInvisible
public void firePopupMenuWillBecomeInvisible()
PopupMenuListeners that the popup portion of the combo box has become invisible. This method is public but should not be called by anything other than the UI delegate.
- Since:
- 1.4
- See Also:
firePopupMenuCanceled
public void firePopupMenuCanceled()
PopupMenuListeners that the popup portion of the combo box has been canceled. This method is public but should not be called by anything other than the UI delegate.
- Since:
- 1.4
- See Also:
setActionCommand
public void setActionCommand(String aCommand)
- Parameters:
-
aCommand- a string containing the "command" that is sent to action listeners; the same listener can then do different things depending on the command it receives
getActionCommand
public String getActionCommand()
- Returns:
- the string containing the "command" that is sent to action listeners.
setAction
@BeanProperty(visualUpdate=true, description="the Action instance connected with this ActionEvent source") public void setAction(Action a)
Action for the ActionEvent source. The new Action replaces any previously set Action but does not affect ActionListeners independently added with addActionListener. If the Action is already a registered ActionListener for the ActionEvent source, it is not re-registered. Setting the Action results in immediately changing all the properties described in Swing Components Supporting Action. Subsequently, the combobox's properties are automatically updated as the Action's properties change.
This method uses three other methods to set and help track the Action's property values. It uses the configurePropertiesFromAction method to immediately change the combobox's properties. To track changes in the Action's property values, this method registers the PropertyChangeListener returned by createActionPropertyChangeListener. The default PropertyChangeListener invokes the actionPropertyChanged method when a property in the Action changes.
- Parameters:
-
a- theActionfor theJComboBox, ornull. - Since:
- 1.3
- See Also:
getAction
public Action getAction()
Action for this ActionEvent source, or null if no Action is set.- Returns:
- the
Actionfor thisActionEventsource; ornull - Since:
- 1.3
- See Also:
configurePropertiesFromAction
protected void configurePropertiesFromAction(Action a)
Action. Refer to Swing Components Supporting Action for more details as to which properties this sets.- Parameters:
-
a- theActionfrom which to get the properties, ornull - Since:
- 1.3
- See Also:
createActionPropertyChangeListener
protected PropertyChangeListener createActionPropertyChangeListener(Action a)
PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties. Warning: If you subclass this do not create an anonymous inner class. If you do the lifetime of the combobox will be tied to that of the Action.
- Parameters:
-
a- the combobox's action - Returns:
- the
PropertyChangeListener - Since:
- 1.3
- See Also:
actionPropertyChanged
protected void actionPropertyChanged(Action action, String propertyName)
PropertyChangeListener returned from createActionPropertyChangeListener. Subclasses do not normally need to invoke this. Subclasses that support additional Action properties should override this and configurePropertiesFromAction. Refer to the table at Swing Components Supporting Action for a list of the properties this method sets.
- Parameters:
-
action- theActionassociated with this combobox -
propertyName- the name of the property that changed - Since:
- 1.6
- See Also:
fireItemStateChanged
protected void fireItemStateChanged(ItemEvent e)
- Parameters:
-
e- the event of interest - See Also:
fireActionEvent
protected void fireActionEvent()
- See Also:
selectedItemChanged
protected void selectedItemChanged()
getSelectedObjects
@BeanProperty(bound=false) public Object[] getSelectedObjects()
ItemSelectable.- Specified by:
-
getSelectedObjectsin interfaceItemSelectable - Returns:
- an array of
Objectscontaining one element -- the selected item
actionPerformed
public void actionPerformed(ActionEvent e)
- Specified by:
-
actionPerformedin interfaceActionListener - Parameters:
-
e- the event to be processed
contentsChanged
public void contentsChanged(ListDataEvent e)
- Specified by:
-
contentsChangedin interfaceListDataListener - Parameters:
-
e- aListDataEventencapsulating the event information
intervalAdded
public void intervalAdded(ListDataEvent e)
- Specified by:
-
intervalAddedin interfaceListDataListener - Parameters:
-
e- aListDataEventencapsulating the event information
intervalRemoved
public void intervalRemoved(ListDataEvent e)
- Specified by:
-
intervalRemovedin interfaceListDataListener - Parameters:
-
e- aListDataEventencapsulating the event information
selectWithKeyChar
public boolean selectWithKeyChar(char keyChar)
- Parameters:
-
keyChar- a char, typically this is a keyboard key typed by the user - Returns:
-
trueif there is an item corresponding to that character. Otherwise, returnsfalse.
setEnabled
@BeanProperty(preferred=true, description="The enabled state of the component.") public void setEnabled(boolean b)
- Overrides:
-
setEnabledin classJComponent - Parameters:
-
b- a boolean value, where true enables the component and false disables it - See Also:
configureEditor
public void configureEditor(ComboBoxEditor anEditor, Object anItem)
- Parameters:
-
anEditor- theComboBoxEditorthat displays the list item in the combo box field and allows it to be edited -
anItem- the object to display and edit in the field
processKeyEvent
public void processKeyEvent(KeyEvent e)
KeyEvents, looking for the Tab key. If the Tab key is found, the popup window is closed.- Overrides:
-
processKeyEventin classJComponent - Parameters:
-
e- theKeyEventcontaining the keyboard key that was pressed - See Also:
setKeySelectionManager
@BeanProperty(bound=false, expert=true, description="The objects that changes the selection when a key is pressed.") public void setKeySelectionManager(JComboBox.KeySelectionManager aManager)
- Parameters:
-
aManager- a key selection manager
getKeySelectionManager
public JComboBox.KeySelectionManager getKeySelectionManager()
- Returns:
- the
KeySelectionManagercurrently in use
getItemCount
@BeanProperty(bound=false) public int getItemCount()
- Returns:
- an integer equal to the number of items in the list
getItemAt
public E getItemAt(int index)
index is out of range (less than zero or greater than or equal to size) it will return null.- Parameters:
-
index- an integer indicating the list position, where the first item starts at zero - Returns:
- the item at that list position; or
nullif out of range
createDefaultKeySelectionManager
protected JComboBox.KeySelectionManager createDefaultKeySelectionManager()
- Returns:
- the
KeySelectionManagercurrently used by the list - See Also:
paramString
protected String paramString()
JComboBox. 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:
-
paramStringin classJComponent - Returns:
- a string representation of this
JComboBox
getAccessibleContext
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
- Specified by:
-
getAccessibleContextin interfaceAccessible - Overrides:
-
getAccessibleContextin classComponent - Returns:
- an AccessibleJComboBox that serves as the AccessibleContext of this JComboBox
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
java.awt.Component.setEnabled(boolean).