javax.swing Documentation Differences

This file contains all the changes in documentation in the package javax.swing as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

This class provides default implementations for the JFC Action interface. Standard behaviors like the get and set methods for Action object properties (icon text and enabled) are defined here. The developer need only subclass this abstract class and define the actionPerformed method.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.41 0246 12/0203/0001 @author Georges Saab @see Action

Defines common behaviors for buttons and menu items. For further information see How to Use Buttons Check Boxes and Radio Buttons a section in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.133 02153 12/0903/01 @author Jeff Dinkins

This class implements accessibility support for the AbstractButton class. It provides an implementation of the Java Accessibility API appropriate to button and menu item user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Extends ChangeListener to be serializable.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Factory method which sets the ActionEvent source's properties according to values from the Action instance. The properties which are set may differ for subclasses. By default the properties which get set are Text Icon Enabled ToolTipText ActionCommand and Mnemonic.

If the Action passed in is null the following things will occur:

• the text is set to null
• the icon is set to null
• enabled is set to true
• the tooltip text is set to null

@param a the Action from which to get the properties or null @since 1.3 @see Action @see #setAction

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fireevent methodparameter. @param eevent the ActionEvent object @see EventListenerList

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fireevent methodparameter. @param event the ItemEvent object @see EventListenerList

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method. @see EventListenerList

Returns the icon used by the button when it's disabled and selected. If not no disabled selection icon has been set the button constructs one from the selection icon. <-- PENDING(jeff): the disabled selection icon really should be created (if necesarynecessary) by the L&F. --> @return the disabledSelectedIcon property @see #getPressedIcon @see #setDisabledIcon

Returns the horizontal position of the text relative to the icon. @return the horizontalTextPosition property one of the following values:

• SwingConstants.RIGHT (the default)
• SwingConstants.LEFT
• SwingConstants.CENTER
• SwingConstants.LEADING
• SwingConstants.TRAILING (the default)

ReturnsGets whether the border shouldborderPainted be paintedproperty. @return true if the border shouldvalue be paintedof the falseborderPainted otherwiseproperty @see #setBorderPainted

ChecksGets whether the "content area" of the button should becontentAreaFilled filledproperty. @return the contentAreaFilled property @see #setFocusPaintedsetContentAreaFilled

ReturnsGets whether focus shouldthe bepaintFocus paintedproperty. @return the paintFocus property @see #setFocusPainted

IdentifiesReturns whether or not this componentComponent can receivebecome the focus owner. @return true if this componentComponent canis receivefocusable; thefalse focusotherwise @see #setFocusable @since JDK1.1 @deprecated As of 1.4 replaced by isFocusable().

ChecksGets whether rollover effectsthe arerolloverEnabled enabledproperty. @return the value of the rolloverEnabled property @see #setFocusPaintedsetRolloverEnabled

Paint the button's border if BorderPainted property is true and the button has a border. @param g the Graphics context in which to paint @see #paint @see #setBorder

Sets whetherthe borderPainted property. If true and the button has a border should bethe border is painted. The default value for the borderPainted property is true. @param b if true and border property is not null the border is painted. @see #isBorderPainted @beaninfo bound: true attribute: visualUpdate true description: Whether the border should be painted.

Sets whetherthe contentAreaFilled property. If true the button shouldwill paint the content area or leave it transparent. If you wish to have a transparent button for example andsuch as an icon only button for example then you should set this to false. Do not call setOpaque(false). Whether theThe default buttonvalue for followsthe the RepaintManagercontentAreaFilled's concept of opacityproperty is L&F depandanttrue.

This function may cause the component's opaque property to change.

The exact behavior of calling this function varies on a component-by-component and L&F-by-L&F basis. @param b if true rollover effectsthe content should be paintedfilled; if false the content area is not filled @see #isContentAreaFilled @see #setOpaque @beaninfo bound: true attribute: visualUpdate true description: Whether the button should paint the content area or leave it transparent.

Sets whetherthe paintFocus property which must be true for the focus shouldstate to be painted. The default value for the paintFocus property is true. Some look and feels might not paint focus state; they will ignore this property. @param b if true the focus state isshould be painted @see #isFocusPainted @beaninfo bound: true attribute: visualUpdate true description: Whether focus should be painted

Sets the horizontal position of the text relative to the icon. @param textPosition one of the following values:

• SwingConstants.RIGHT (the default)
• SwingConstants.LEFT
• SwingConstants.CENTER
• SwingConstants.LEADING
• SwingConstants.TRAILING (the default)

@exception IllegalArgumentException if textPosition is not one of the legal values listed above @beaninfo bound: true enum: LEFT SwingConstants.LEFT CENTER SwingConstants.CENTER RIGHT SwingConstants.RIGHT LEADING SwingConstants.LEADING TRAILING SwingConstants.TRAILING attribute: visualUpdate true description: The horizontal position of the text relative to the icon.

SpecifiesThis method is now obsolete please use setMnemonic(int) to set the mnemonic valuefor a button. This method is only designed to handle character values which fall between 'a' and 'z' or 'A' and 'Z'. @param mnemonic a char specifying the mnemonic value @see #setMnemonic(int) @beaninfo bound: true attribute: visualUpdate true description: the keyboard character mnemonic

Sets the keyboard mnemonic on the current model. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate this button if focus is contained somewhere within this button's ancestor window.

A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent. Mnemonics are case-insensitive therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed.

If the character defined by the mnemonic is found within the button's label string the first occurrence of it will be underlined to indicate the mnemonic to the user. If the corresponding character is not contained within the button's label then it will be displayed near the label in a look and feel dependent manner (commonly to the right surrounded by parenthesis). @param mnemonic the key code which represents the mnemonic @see java.awt.event.KeyEvent @beaninfo bound: true attribute: visualUpdate true description: the keyboard character mnemonic

Sets whetherthe rolloverEnabled property which must be true for rollover effects shouldto beoccur. enabledThe default value for the rolloverEnabled property is false. Some look and feels might not implement rollover effects; they will ignore this property. @param b if true rollover effects should be painted @see #isRolloverEnabled @beaninfo bound: true attribute: visualUpdate true description: Whether rollover effects should be enabled.

Sets the L&F object that renders this component. @param ui the ButtonUI L&F object @see #getUI @beaninfo bound: true hidden: true attribute: visualUpdate true description: The UI object that implements the LookAndFeel.

NotificationResets from the UIFactoryUI property thatto a value from the L&Fcurrent look has changedand feel. Subtypes of AbstractButton should override this to update the UI. For example JButton might do the following:

 setUI((ButtonUI)UIManager.getUI( "ButtonUI" "javax.swing.plaf.basic.BasicButtonUI" this)); 

Identifies a change from rolloverto enabled to disabled or back to enabledhaving the button paint the content area.

Identifies a change in thefrom rollover button'senabled to disabled or back to enabled.

@version 1.4 028 12/0203/0001 A base class for CellEditors providing default implementations for the methods in the CellEditor interface except getCellEditorValue(). Like the other abstract implementations in Swing also manages a list of listeners.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @author Philip Milne

The Abstractabstract definition for the data model thethat provides a List with its contents.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.22 0230 12/0203/0001 @author Hans Muller

AddAdds a listener to the list that's notified each time a change to the data model occurs. @param l the ListDataListener to be added

AbstractListModel subclasses must call this method after one or more elements of the list change. The changed elements are specified by athe closed interval index0 index1 i.e.-- the range that includes both index0endpoints and index1are included. Note that index0 need not be less than or equal to index1. @param source Thethe ListModel that changed typically "this". @param index0 Oneone end of the new interval. @param index1 Thethe other end of the new interval. @see EventListenerList @see DefaultListModel

AbstractListModel subclasses must call this method after one or more elements are added to the model. The new elements are specified by a closed interval index0 index1 i.e.-- the range that includesenpoints both index0 andare index1included. Note that index0 need not be less than or equal to index1. @param source Thethe ListModel that changed typically "this". @param index0 Oneone end of the new interval. @param index1 Thethe other end of the new interval. @see EventListenerList @see DefaultListModel

AbstractListModel subclasses must call this method after one or more elements are removed from the model. The new elements are specified by a closed interval index0 index1 i.e. the range that includes both index0 and index1. Note that index0 need not be less than or equal to index1. @param source Thethe ListModel that changed typically "this". @param index0 Oneone end of the new interval. @param index1 Thethe other end of the new interval. @see EventListenerList @see DefaultListModel

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

You can specify the listenerType argument with a class literal such as FooListener.class. For example you can query a list model m for its list data listeners ofwith the givenfollowing typecode: that

ListDataListener[] ldls = (ListDataListener[])(m.getListeners(ListDataListener.class));

wereIf addedno such tolisteners exist this modelmethod returns an empty array. @returnsparam alllistenerType the type of thelisteners requested; this parameter should specify an interface that descends from java.util.EventListener @return an array of all objects recievingregistered as listenerTypeFooListeners notificationson from this model or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getListDataListeners @since 1.3

RemoveRemoves a listener from the list that's notified each time a change to the data model occurs. @param l the ListDataListener to be removed

The Action interface provides a useful extension to the ActionListener interface in cases where the same functionality may be accessed by several controls.

In addition to the actionPerformed method defined by the ActionListener interface this interface allows the application to define in a single place:

• One or more text strings that describe the function. These strings can be used for example to display the flyover text for a button or to set the text in a menu item.
• One or more icons that depict the function. These icons can be used for the images in a menu control or for composite entries in a more sophisticated user interface.
• The enabled/disabled state of the functionality. Instead of having to separately disable the menu item and the toolbar button the application can disable the function that implements this interface. All components which are registered as listeners for the state change then know to disable event generation for that item and to modify the display accordingly.

Certain containers including menus and tool bars know how to add an Action object. When an Action object is added to such a container the container:

1. Creates a component that is appropriate for that container (a tool bar creates a button component for example).
2. Gets the appropriate property(s) from the Action object to customize the component (for example the icon image and flyover text).
3. Checks the intialinitial state of the Action object to determine if it is enabled or disabled and renders the component in the appropriate fashion.
4. Registers a listener with the Action object so that is notified of state changes. When the Action object changes from enabled to disabled or back the container makes the appropriate revisions to the event-generation mechanisms and renders the component accordingly.

For example both a menu item and a toolbar button could access a Cut action object. The text associated with the object is specified as "Cut" and an image depicting a pair of scissors is specified as its icon. The Cut action-object can then be added to a menu and to a tool bar. Each container does the appropriate things with the object and invokes its actionPerformed method when the component associated with it is activated. The application can then disable or enable the application object without worrying about what user-interface components are connected to it.

This interface can be added to an existing class or used to create an adapter (typically by subclassing AbstractActio). The Action object can then be added to multiple action-aware containers and connected to Action-capable components. The GUI controls can then be activated or deactivated all at once by invoking the Action object's setEnabled method.

Note that Action implementations tend to be more expensive in terms of storage than a typical ActionListener which does not offer the benefits of centralized control of functionality and broadcast of property changes. For th is reason you should take care to only use Actions where their benefits are desired and use simple ActionListeners elsewhere. @version 1.2124 0212/0203/0001 @author Georges Saab @see AbstractAction

The key used for storing a KeyStroke to be used as the accelerator for the action. @since 1.3

The key used for storing an int key code to be used as the mnemonic for the action. @since 1.3

ActionMap provides mappings from Objects (called keys or Action names) to Actions. An ActionMap is usually used with an InputMap to locate a particular action when a key is pressed. As with InputMap an ActionMap can have a parent that is searched for keys not defined in the ActionMap.

As with InputMap if you create a cycle eg:

 ActionMap am = new ActionMap(); ActionMap bm = new ActionMap(): am.setParent(bm); bm.setParent(am); 

some of the methods will cause a StackOverflowError to be thrown. @see InputMap @version 1.8 0211 12/0203/0001 @author Scott Violet

Factory class for vending standard Border objects. Wherever possible this factory will hand out references to shared Border instances. For further information and examples see How to Use Borders a section in The Java Tutorial. @version 1.23 0225 12/0203/0001 @author David Kloba

Creates a new title border with an empty title specifying the border object using the default text position (sitting on the top line) and default justification (leading) and using the default font and text color. and@param border determined by the current lookBorder andobject feel.to (Theadd Motif and Windows look and feelsthe title to if null the useBorder an etchedis determined border;by The Javathe current look and feel uses a gray border.) @param border thetitle a BorderString object to addcontaining the text of the title to @return the TitledBorder object

Defines the data model used by components like Sliders and ProgressBars. Defines four interrelated integer properties: minimum maximum extent and value. These four integers define two nested ranges like this:

 minimum < value < value+extent < maximum 

The outer range is minimum maximum and the inner range is value value+extent. The inner range must lie within the outer one i.e. value must be less than or equal to maximum and value+extent must greater than or equal to minimum and maximum must be greater than or equal to minimum. There are a few features of this model that one might find a little surprising. These quirks exist for the convenience of the Swing BoundedRangeModel clients like like Slider and ScrollBar.

• The minimum and maximum set methods "correct" the other three properties to acommodateaccommodate their new value argument. For example setting the model's minimum may change its maximum value and extent properties (in that order) to maintain the constraints specified above.
• The value and extent set methods "correct" their argument to fit within the limits defined by the other three properties. For example if value == maximum setExtent(10) would change the extent (back) to zero.
• The four BoundedRangeModel values are defined as Java Beans properties however Swing ChangeEvents are used to notify clients of changes rather than PropertyChangeEvents. This was done to keep the overhead of monitoring a BoundedRangeModel low. Changes are often reported at MouseDragged rates.

For an example of specifying custom bounded range models used by sliders see The Anatomy of a Swing-Based Program in The Java Tutorial. @version 1.2224 0212/0203/0001 @author Hans Muller @see DefaultBoundedRangeModel

This method sets all of the model's data with a single method call. The method results in a single change event being generated. This is convenient when you need to adjust all the model data simulaneouslysimultaneously and do not want individual change events to occur. @param value an int giving the current value @param extent an int giving the amount by which the value can "jump" @param min an int giving the minimum value @param max an int giving the maximum value @param isAdjusting a boolean true if a series of changes are in progress @see #setValue @see #setExtent @see #setMinimum @see #setMaximum @see #setValueIsAdjusting

A lightweight container that uses a BoxLayout object as its layout manager. Box provides several class methods that are useful for containers using BoxLayout -- even non-Box containers.

The Box class can create several kinds of invisible components that affect layout: glue struts and rigid areas. If all the components your Box contains have a fixed size you might want to use a glue component (returned by createGlue) to control the components' positions. If you need a fixed amount of space between two components try using a strut (createHorizontalStrut or createVerticalStrut). If you need an invisible component that always takes up the same amount of space get it by invoking createRigidArea.

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. A futureAs release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see BoxLayout @author Timothy Prinzing @version 1.36 0837 12/0503/0001

An implementation of a lightweight component that participates in layout but has no view.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

A layout manager that allows multiple components to be layedlaid out either vertically or horizontally. The components will not wrap so for example a vertical arrangement of components will stay vertically arranged when the frame is resized.

Nesting multiple panels with different combinations of horizontal and vertical gives an effect similar to GridBagLayout without the complexity. The diagram shows two panels arranged horizontally each of which contains 3 components arranged vertically.

The Box container uses BoxLayout (unlikemanager JPanel which defaults to flowis constructed with an axis layout).parameter You can nest multiple boxes and add components tothat specifies the type of layout that will be themdone. to get theThere are four arrangementchoices: you

X_AXIS want.- The BoxLayout manager that places each ofComponents are laid out horizontally from left to itsright.

managed

Y_AXIS components from left to right or- Components are laid out vertically from top to bottom.

When

LINE_AXIS you- Components are laid out the way words are createlaid out in a BoxLayout you specify whetherline based on the itscontainer's majorComponentOrientation axisproperty. isIf the Xcontainer's axisComponentOrientation (whichis meanshorizontal then components are laid out horizontally otherwise they are laid out vertically. For horizontal orientations if the container's ComponentOrientation is left to right placement)then or Y axiscomponents are laid (topout left to bottomright placement).otherwise Componentsthey are arrangedlaid from leftout right to rightleft. (orFor vertical orientations components are always laid out from top to bottom).

in

PAGE_AXIS - Components are laid out the same order as they were addedway text lines are laid out toon a page based on the container's ComponentOrientation property. InsteadIf the ofcontainer's usingComponentOrientation BoxLayout directly many programs use the Boxis horizontal then components are laid out class.vertically The Box class provides aotherwise they are laid out lightweighthorizontally. For horizontal orientations if the container's thatComponentOrientation uses ais left BoxLayoutto right then components are laid out left to right otherwise they are laid out right to left.  Box also provides handyFor vertical orientations components methodsare always laid out from top to helpbottom.

you use BoxLayout

For all welldirections components are arranged in the same order as they were added to the container.

BoxLayout attempts to arrange components at their preferred widths (for left to righthorizontal layout) or heights (for top to bottomvertical layout). For a left to righthorizontal layout if not all the components are the same height BoxLayout attempts to make all the components as high as the highest component. If that's not possible for a particular component then BoxLayout aligns that component vertically according to the component's Y alignment. By default a component has ana Y alignment of 0.5 which means that the vertical center of the component should have the same Y coordinate as the vertical centers of other components with 0.5 Y alignment.

Similarly for a vertical layout BoxLayout attempts to make all components in the column as wide as the widest component;. ifIf that fails it aligns them horizontally according to their X alignments. For PAGE_AXIS layout horizontal alignment is done based on the leading edge of the component. In other words an X alignment value of 0.0 means the left edge of a component if the container's ComponentOrientation is left to right and it means the right edge of the component otherwise.

Instead of using BoxLayout directly many programs use the Box class. The Box class is a lightweight container that uses a BoxLayout. It also provides handy methods to help you use BoxLayout well. Adding components to multiple nested boxes is a powerful way to get the arrangement you want.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see Box @see Componentjava.awt.ComponentOrientation @see JComponent#getAlignmentX @see ComponentJComponent#getAlignmentY @author Timothy Prinzing @version 1.2529 0312/0203/01

Creates a layout manager that will lay out components either left to right or top to bottom as specified inalong the axisgiven parameteraxis. @param target the container that needs to be laid out @param axis the axis to lay out components along. ForCan left-to-rightbe layoutone specifyof: BoxLayout.X_AXIS; for top-to-bottomBoxLayout.Y_AXIS layoutBoxLayout.LINE_AXIS specifyor BoxLayout.YPAGE_AXIS @exception AWTError if the value of axis is invalid

This class is used to create a multiple-exclusion scope for a set of buttons. Creating a set of buttons with the same ButtonGroup object means that turning "on" one of those buttons turns off all other buttons in the group.

A ButtonGroup can be used with any set of objects that inherit from AbstractButton. Typically a button group contains instances of JRadioButton JRadioButtonMenuItem or JToggleButton. It wouldn't make sense to put an instance of JButton or JMenuItem in a button group because JButton and JMenuItem don't implement the selected state.

Initially all buttons in the group are unselected. Once any button is selected one button is always selected in the group. There is no way to turn a button programmatically to "off" in order to clear the button group. To give the appearance of "none selected" add an invisible radio button to the group and then programmatically select that button to turn off all the displayed radio buttons. For example a normal button with the label "none" could be wired to select the invisible radio button.

For examples and further information on using button groups see How to Use Radio Buttons a section in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A futureAs release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.27 0232 12/0203/0001 @author Jeff Dinkins

Creates a new ButtonGroup.

Adds the button to the group. @param b the button to be added

Returns the number of buttons in the group. @return the button count

ReturnReturns all the buttons that are participating in this group. @return an Enumeration of the buttons in this group

ReturnReturns the model of the selected button. @return the selected button model.

Returns thewhether a ButtonModel is selected. @return valuetrue forif the button. is selected otherwise returns false

Removes the button from the group. @param b the button to be removed

Sets the selected value for the ButtonModel. Only one button in the group may be selected at a time. @param the ButtonModel @param true if this button is to be selected otherwise false

State Model for buttons. This model is used for check boxes and radio buttons which are special kinds of buttons as well as for normal buttons. For check boxes and radio buttons pressing the mouse selects the button. For normal buttons pressing the mouse "arms" the button. Releasing the mouse over the button then initiates a button press firing its action event. Releasing the mouse elsewhere disarms the button.

In use a UI will invoke #setSelected when a mouse click occurs over a check box or radio button. It will invoke #setArmed when the mouse is pressed over a regular button and invoke #setPressed when the mouse is released. If the mouse travels outside the button in the meantime setArmed(false) will tell the button not to fire when it sees setPressed. (If the mouse travels back in the button will be rearmed.)

Note:
A button is triggered when it is both "armed" and "pressed".

@version 1.23 0224 12/0203/0001 @author Jeff Dinkins

This interface defines the methods any general editor should be able to implement.

Having this interface enables complex components (the client of the editor) such as JList JTree and JTable to allow any generic editor to edit values in a table cell or tree cell etc. Without this generic editor interface JTable would have to know about specific editors such as JTextField JCheckBox JComboBox etc. In addition without this interface clients of editors such as JTable would not be able to work with any editors developed in the future by the user or a 3rd party ISV.

To use this interface a developer creating a new editor can have the new component implement the interface. Or the developer can choose a wrapper based approchapproach and provide a companion object which implements the CellEditor interface (See JCellEditor for example). The wrapper approchapproach is particularly useful if the user want to use a 3rd party ISV editor with JTable but the ISV didn't implement the CellEditor interface. The user can simply create an object that contains an instance of the 3rd party editor object and "translate" the CellEditor API into the 3rd party editor's API. @see javax.swing.event.CellEditorListener @version 1.19 0222 12/0203/0001 @author Alan Chung

AddAdds a listener to the list that's notified when the editor starts stops or cancels editing. @param l the CellEditorListener

TellTells the editor to cancel editing and not accept any partially edited value.

Returns the value contained in the editor. @return the value contained in the editor

AskAsks the editor if it can start editing using anEvent. anEvent is in the invoking component coordinate system. The editor can not assume the Component returned by getCellEditorComponent() is installed. This method is intended for the use of client to avoid the cost of setting up and installing the editor component if editing is not possible. If editing can be started this method returns true. @param anEvent the event the editor should use to consider whether to begin editing or not. @return true if editing can be started. @see #shouldSelectCell

RemoveRemoves a listener from the list that's notified @param l the CellEditorListener

TheReturns return value of shouldSelectCell() is a boolean indicatingtrue whetherif the editing cell should be selected orfalse nototherwise. Typically the return value is true because is most cases the editing cell should be selected. However it is useful to return false to keep the selection from changing for some types of edits. eg. A table that contains a column of check boxes the user might want to be able to change those checkboxes without altering the selection. (See Netscape Communicator for just such an example) Of course it is up to the client of the editor to use the return value but it doesn't need to if it doesn't want to. @param anEvent the event the editor should use to start editing. @return true if the editor would like the editing cell to be selected; otherwise returns false @see #isCellEditable

TellTells the editor to stop editing and accept any partially edited value as the value of the editor. The editor returns false if editing was not stopped; this is useful for editors which validatesthat validate and can not accept invalid entries. @return true if editing was stopped; false otherwise

This class is inserted in between cell renderers and the components that use them. It just exists to thwart the repaint() and invalidate() methods which would otherwise propogatepropagate up the tree when the renderer was configured. It's used by the implementations of JTable JTree and JList. For example here's how CellRendererPane is used in the code the paints each row in a JList:

 cellRendererPane = new CellRendererPane(); ... Component rendererComponent = renderer.getListCellRendererComponent(); renderer.configureListCellRenderer(dataModel.getElementAt(row) row); cellRendererPane.paintComponent(g rendererComponent this x y w h); 

A renderer component must override isShowing() and unconditionally return true to work correctly because the Swing paint does nothing for components with isShowing false.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.34 0836 12/0503/0001 @author Hans Muller

Overridden to avoid propogatingpropagating a invalidate up the tree when the cell renderer child is configured.

Paint a cell renderer component c on graphics object g. Before the component is drawn it's reparented to this (if that's neccessarynecessary) it's bounds are set to w h and the graphics object is (effectively) translated to x y. If it's a JComponent double buffering is temporarily turned off. After the component is painted it's bounds are reset to -w -h 0 0 so that if it's the last renderer component painted it will not start consuming input. The Container p is the component we're actually drawing on typically it's equal to this.getParent(). If shouldValidate is true the component c will be validated before painted.

The editor component used for JComboBox components. @version 1.10 0211 12/0203/0001 @author Arnaud Weber

ComboBoxDataModelA isdata model for a combo box. This interface extends ListDataModel and adds the concept withof a selected item. ThisThe selected item is generally the item which is visible in the model since itcombo box display isarea.

The selected item may not alwaysnecessarily inbe managed by the underlying ListModel. This disjoint behavior allows for the temporary storage and retrieval of a selected item listin the model. @version 1.13 12/03/01 @author Arnaud Weber

ReturnReturns the selected item @return The selected item or null if there is no selection

Set the selected item. The implementation of this method should notify all registered ListDataListeners that the contents have changed. @param anItem the list object to select or null to clear the selection

A ComponentInputMap is an InputMap associated with a particular JComponent. The component is automatically notified whenever the ComponentInputMap changes. ComponentInputMaps are used for WHEN_IN_FOCUSED_WINDOW bindings. @version 1.6 027 12/0203/0001 @author Scott Violet

Graphics subclass supporting graphics debugging. Overrides most methods from Graphics. DebugGraphics objects are rarely created by hand. They are most frequently created automatically when a JComponent's debugGraphicsOptions are changed using the setDebugGraphicsOptions() method.

NOTE: You must turn off double buffering to use DebugGraphics: RepaintManager repaintManager = RepaintManager.currentManager(component); repaintManager.setDoubleBufferingEnabled(false); @see JComponent#setDebugGraphicsOptions @see RepaintManager#currentManager @see RepaintManager#setDoubleBufferingEnabled @version 1.20 0722 12/2603/0001 @author Dave Karlton

Show buffered operations in a seperateseparate Frame.

A generic implementation of BoundedRangeModel.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.35 0242 12/0203/0001 @author David Kloba @author Hans Muller @see BoundedRangeModel

Initializes value extent minimum and maximum. Adjusting is false. Throws an IllegalArgumentException if the following constraints aren't satisfied:

 min < value < value+extent < max 

Adds a ChangeListener. The change listeners are run each time any one of the Bounded Range model properties changes. @param l the ChangeListener to add @see #removeChangeListener @see BoundedRangeModel#addChangeListener

RunRuns each ChangeListenersChangeListener's stateChanged() method. @see #setRangeProperties @see EventListenerList

ReturnReturns the model's extent. @return the model's extent @see #setExtent @see BoundedRangeModel#getExtent

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

You can specify the listenerType argument with a class literal such as FooListener.class. For example you can query a DefaultBoundedRangeModel instance m for its change listeners ofwith the givenfollowing typecode: that

ChangeListener[] cls = (ChangeListener[])(m.getListeners(ChangeListener.class));

wereIf addedno such listeners toexist this modelmethod returns an empty array. @returnsparam alllistenerType the type of thelisteners requested; this parameter should specify an interface that descends from java.util.EventListener @return an array of all objects recievingregistered as listenerTypeFooListeners notificationson from this model or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getChangeListeners @since 1.3

ReturnReturns the model's maximum. @return the model's maximum @see #setMaximum @see BoundedRangeModel#getMaximum

ReturnReturns the model's minimum. @return the model's minimum @see #setMinimum @see BoundedRangeModel#getMinimum

ReturnReturns the model's current value. @return the model's current value @see #setValue @see BoundedRangeModel#getValue

Returns true if the value is in the process of changing as a result of actions being taken by the user. @return the value of the valueIsAdjusting property @see #setValue @see BoundedRangeModel#getValueIsAdjusting

Removes a ChangeListener. @param l the ChangeListener to remove @see #addChangeListener @see BoundedRangeModel#removeChangeListener

Sets all of the BoundedRangeModel properties after forcing the arguments to obey the usual constraints:

 minimum < value < value+extent < maximum 

At most one ChangeEvent is generated. @see BoundedRangeModel#setRangeProperties @see #setValue @see #setExtent @see #setMinimum @see #setMaximum @see #setValueIsAdjusting

Sets the valueIsAdjusting property. @see #getValueIsAdjusting @see #setValue @see BoundedRangeModel#setValueIsAdjusting

Returns a string that displays all of the BoundedRangeModel properties.

Only one ChangeEvent is needed per model instance since the event's only (read-only) state is the source property. The source of events generated here is always "this".

The default implementation of a Button component's data model.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.32 0241 12/0203/0001 @author Jeff Dinkins

Constructs a default JButtonModel.

Adds an ActionListener to the button. @param l the listener to add

Adds a ChangeListener to the button. @param l the listener to add

Adds an ItemListener to the button. @param l the listener to add

Returns the action command for this button. @return the String that identifies the generated event @see #setActionCommand

Returns the group that this button belongs to. Normally used with radio buttons which are mutually exclusive within their group. @return a ButtonGroup that this button belongs to @since 1.3

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

You can specify the listenerType argument with a class literal such as FooListener.class. For example you can query a DefaultButtonModel instance m for its action listeners ofwith the givenfollowing typecode: that

ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));

were added toIf no such listeners exist this modelmethod returns an empty array. @returns allparam listenerType the type of thelisteners requested; this parameter should specify an interface that descends from java.util.EventListener @return an array of all objects recievingregistered as listenerTypeFooListeners notificationson from this model or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getActionListeners @see #getChangeListeners @see #getItemListeners @since 1.3

OverridenOverridden to return null.

Indicates ifwhether the button can be selected or pressed by an input device (such as a mouse pointer). (Checkbox-buttons are selected regular buttons are "pressed".) @return true if the button is enabled and therefore selectable (or pressable)

Indicates ifwhether button has been pressed. @return true if the button has been pressed

Removes an ActionListener from the button. @param l the listener to remove

Removes a ChangeListener from the button. @param l the listener to remove

Removes an ItemListener from the button. @param l the listener to remove

Sets the actionCommand string that gets sent as part of the event when the button is pressed. @param s the String that identifies the generated event

Identifies the group this button belongs to -- needed for radio buttons which are mutually exclusive within their group. @param group the ButtonGroup this button belongs to

Selects or deselects the button. @param b true selects the button false deselects the button.

Only one ChangeEvent is needed per button model instance since the event's only state is the source property. The source of events generated is always "this".

The default editor for table and tree cells.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.38 0246 12/0203/0001 @author Alan Chung @author Philip Milne

Constructs a DefaultCellEditor object that uses a check box. @param x a JCheckBox object ...

Constructs a DefaultCellEditor object that uses a combo box. @param x a JComboBox object ...

Constructs a DefaultCellEditor that uses a text field. @param x a JTextField object ...

ClickCountToStartReturns controls the number of clicks requiredneeded to start editing. @returns the number of clicks needed to start editing

Returns the a reference to the editor component. @return the editor Component

The default model for combo boxes. @version 1.11 0215 12/0203/0001 @author Arnaud Weber @author Tom Santos

This is an implementaionimplementation of the DesktopManager. It currently implements a the basic behaviors for managing JInternalFramesJInternalFrames in an arbitrary parent. JInternalFramesJInternalFrames that are not children of a JDesktop will use this component to handle their desktop-like actions. @see JDesktopPane @see JInternalFrame @version 1.41 0245 12/0203/0001 @author David Kloba @author Steve Wilson

This will activate f moving it to the front. It will set the current active frame's (if any) IS_SELECTED_PROPERTY to false. There can be only one active frame across all Layers. @param f the JInternalFrame to be activated

Removes the frame and if necessary the desktopIcon from its parent. @param f the JInternalFrame to be removed

Removes the desktopIcon from its parent and adds its frame to the parent. @param f the JInternalFrame to be de-iconified

Moves the visible location of the frame being dragged to the location specified. The means by which this occurs can vary depending on the dragging algorithm being used. The actual logical location of the frame might not change until endDraggingFrame is called.

Removes the frame from its parent and adds its desktopIcon to the parent. @param f the JInternalFrame to be iconified

Resizes the frame to fill its parents bounds. @param the frame to be resized

Restores the frame back to its size and position prior to a maximizeFrame() call. @param f the JInternalFrame to be restored

ConvienceConvenience method to remove the desktopIcon of f is necessary.

Calls setBoundsForFrame() with the new values. @param f the component to be resized @param newX the new x-coordinate @param newY the new y-coordinate @param newWidth the new width @param newHeight the new height

This moves the JComponent and repaints the damaged areas.

Stores the bounds of the component just before a maximize call. @param f the component about to be resized @param r the normal bounds to be saved away

Sets that the component has been iconized and the bounds of the desktopIcon are valid.

Default swingThis class has been obsoleted by the 1.4 focus managerAPIs. While client code may still use this class developers are strongly encouraged to use java.awt.KeyboardFocusManager and java.awt.DefaultKeyboardFocusManager instead. Please see the Focus implementationSpecification for more information. @see Focus Specification @version 1.15 0726 12/1303/9901 @author Arnaud Weber @author David Mendenhall

Renders an item in a list.

Implementation Note: This class overrides validate revalidate repaint and firePropertyChange solely to improve performance. If not overridden these frequently called methods would execute code paths that are unnecessary for the default list cell renderer. If you write your own renderer take care to weigh the benefits and drawbacks of overriding these methods.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.18 0721 12/2603/0001 @author Philip Milne @author Hans Muller

A subclass of DefaultListCellRenderer that implements UIResource. DefaultListCellRenderer doesn't implement UIResource directly so that applications can safely override the cellRenderer property with DefaultListCellRenderer subclasses.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

This class loosely implements the java.util.Vector API in that it implements the 1.1.x version of java.util.Vector has no collection class support and notifies the ListDataListenersListDataListeners when changes occur. Presently it delegates to a Vector in a future release it will be a real Collection implementation.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.26 0231 12/0203/0001 @author Hans Muller

Inserts the specified element at the specified position in this list.

Throws an ArrayIndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). @param index index at which the specified element is to be inserted. @param element element to be inserted.

Adds the specified component to the end of this list. @param obj the component to be added. @see Vector#addElement(Object)

Tests ifwhether the specified object is a component in this list. @param elem an object. @return true if the specified object is the same as a component in this list @see Vector#contains(Object)

Copies the components of this list into the specified array. The array must be big enough to hold all the objects in this list else an IndexOutOfBoundsException is thrown. @param anArray the array into which the components get copied. @see Vector#copyInto(Object[])

Returns the component at the specified index. Throws an ArrayIndexOutOfBoundsException if the index is negative or not less than the size of the list.

Note: Although this method is not deprecated the preferred method to use is get(int) which implements the List interface defined in the 1.2 Collections framework.

@param index an index into this list. @return the component at the specified index. @see #get(int) @see Vector#elementAt(int)

Returns an enumeration of the components of this list. @return an enumeration of the components of this list. @see Vector#elements()

Increases the capacity of this list if necessary to ensure that it can hold at least the number of components specified by the minimum capacity argument. @param minCapacity the desired minimum capacity. @see Vector#ensureCapacity(int)

Returns the first component of this list. Throws a NoSuchElementException if this vector has no components *. @return the first component of this list @see Vector#firstElement()

Returns the element at the specified position in this list.

Throws an ArrayIndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). @param index index of element to return.

Returns the component at the specified index.

Note: Although this method is not deprecated the preferred method to use is get(int) which implements the List interface defined in the 1.2 Collections framework.

@param index an index into this list. @return the component at the specified index. @exception ArrayIndexOutOfBoundsException if the index is negative or not lessgreater than the current size of this list. given. @see #get(int)

Returns the number of components in this list.

This method is identical to size() which implements the List interface defined in the 1.2 Collections framework. This method exists in conjunction with setSize() so that "size" is identifiable as a JavaBean property. @return the number of components in this list. @see #size()

Searches for the first occurenceoccurrence of the given argumentelem. @param elem an object. @return the index of the first occurrence of the argument in this list; returns -1 if the object is not found. @see Vector#indexOf(Object)

Searches for the first occurenceoccurrence of the given argumentelem beginning the search at index. @param elem an object.desired component @param index the index from which to startbegin searching from. @return the index ofwhere the first occurrence of the object argument in thiselem list at positionis found after index or later in the list; returns -1 if the objectelem is not found. in the list @see Vector#indexOf(Object int)

Inserts the specified object as a component in this list at the specified index.

Throws an ArrayIndexOutOfBoundsException if the index is invalid.

Note: Although this method is not deprecated the preferred method to use is add(int Object) which implements the List interface defined in the 1.2 Collections framework.

@param obj the component to insert. @param index where to insert the new component. @exception ArrayIndexOutOfBoundsException if the index was invalid. @see #add(int Object) @see Vector#insertElementAt(Object int)

Tests ifwhether this list has noany components. @return true if and only if this list has no components that is its size is zero; false otherwise. @see Vector#isEmpty()

Returns the last component of the list. Throws a NoSuchElementException if this vector has no components *. @return the last component of the list @see Vector#lastElement()

Returns the index of the last occurrence of the specified object in this listelem. @param elem the desired component. @return the index of the last occurrence of the specified objectelem in thisthe list; returns -1 if the object is not found. @see Vector#lastIndexOf(Object)

Searches backwards for the specified objectelem starting from the specified index and returns an index to it. @param elem the desired component. @param index the index to start searching from. @return the index of the last occurrence of the specified objectelem in this list at position less than index in the list; returns -1 if the object is not found. @see Vector#lastIndexOf(Object int)

Removes the element at the specified position in this list. Returns the element that was removed from the list.

Throws an ArrayIndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). @param index the index of the element to removed.

Removes all components from this list and sets its size to zero.

Note: Although this method is not deprecated the preferred method to use is clear() which implements the List interface defined in the 1.2 Collections framework.

@see #clear() @see Vector#removeAllElements()

Removes the first (lowest-indexed) occurrence of the argument from this list. @param obj the component to be removed. @return true if the argument was a component of this list; false otherwise. @see Vector#removeElement(Object)

Deletes the component at the specified index.

Throws an ArrayIndexOutOfBoundsException if the index is invalid.

Note: Although this method is not deprecated the preferred method to use is remove(int) which implements the List interface defined in the 1.2 Collections framework.

@param index the index of the object to remove. @see #remove(int) @see Vector#removeElementAt(int)

Deletes the components at the specified range of indexes. The removal is inclusive so specifying a range of (1 5) removes the component at index 1 and the component at index 5 as well as all components in between.

Throws an ArrayIndexOutOfBoundsException if the index was invalid. Throws an IllegalArgumentException if fromIndex > toIndex. @param fromIndex the index of the lower end of the range @param toIndex the index of the upper end of the range @see #remove(int)

Replaces the element at the specified position in this list with the specified element.

Throws an ArrayIndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()). @param index index of element to replace. @param element element to be stored at the specified position. @return the element previously at the specified position.

Sets the component at the specified index of this list to be the specified object. The previous component at that position is discarded.

Throws an ArrayIndexOutOfBoundsException if the index is invalid.

Note: Although this method is not deprecated the preferred method to use is set(int Object) which implements the List interface defined in the 1.2 Collections framework.

@param obj what the component is to be set to. @param index the specified index. @see #set(int Object) @see Vector#setElementAt(Object int)

Sets the size of this list. @param newSize the new size of this list. @see Vector#setSize(int)

Returns the number of components in this list. @return the number of components in this list. @see Vector#size()

Returns an array containing all of the elements in this list in the correct order. Throws an ArrayStoreException if the runtime type of the array a is not a supertype of the runtime type of every element in this list. @param a the array into which the elements of the list are to be stored if it is big enough; otherwise a new array of the same runtime type is allocated for this purpose. @return an array containing the elements of the list. @see Vector#toArray()

Default data model for list selections.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.55 0265 12/0203/0001 @author Philip Milne @author Hans Muller @see ListSelectionModel

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

You can specify the listenerType argument with a class literal such as FooListener.class. For example you can query a DefaultListSelectionModel instance m for its list selection listeners ofwith the givenfollowing typecode: that

ListSelectionListener[] lsls = (ListSelectionListener[])(m.getListeners(ListSelectionListener.class));

wereIf addedno such tolisteners exist this modelmethod returns an empty array. @param listenerType the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener @return allan array of theall objects receivingregistered as listenerTypeFoo notificationsListeners fromon this model or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getListSelectionListeners @since 1.3

A generic implementation of SingleSelectionModel.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.25 0232 12/0203/0001 @author Dave Moore

Adds a ChangeListener to the button.

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

You can specify the listenerType argument with a class literal such as FooListener.class. For example you can query a DefaultSingleSelectionModel instance m for its change listeners ofwith the givenfollowing typecode: that

ChangeListener[] cls = (ChangeListener[])(m.getListeners(ChangeListener.class));

wereIf addedno such listeners toexist this modelmethod returns an empty array. @returnsparam alllistenerType the type of thelisteners requested; this parameter should specify an interface that descends from java.util.EventListener @return an array of all objects recievingregistered as listenerTypeFooListeners notificationson from this model or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getChangeListeners @since 1.3

Removes a ChangeListener from the button.

DesktopManager objects are owned by a JDesktopPane object. They are responsible for implementing L&F specific behaviors for the JDesktopPane. JInternalFrame implementations should delegate specific behaviors to the DesktopManager. For instance if a JInternalFrame was asked to iconify it should try:

 getDesktopPane().getDesktopManager().iconifyFrame(frame); 

This delegation allows each L&F to provide custom behaviors for desktop-specific actions. (For example how and where the internal frame's icon would appear.) @see JDesktopPane @see JInternalFrame @see JInternalFrame.JDesktopIcon @version 1.10 0212 12/0203/0001 @author David Kloba

The user has moved the frame. Calls to this method will be preceededpreceded by calls to beginDraggingFrame(). Normally f will be a JInternalFrame.

The user has resized the component. Calls to this method will be preceededpreceded by calls to beginResizingFrame(). Normally f will be a JInternalFrame.

This is a primativeprimitive reshape method.

SwingThis class has been obsoleted by the 1.4 focus APIs. While client code may still use this class developers are strongly encouraged to use java.awt.KeyboardFocusManager and java.awt.DefaultKeyboardFocusManager instead. Please see the Focus Specification for more information. @see Focus ManagerSpecification @version 1.11 0223 12/0203/0001 @author Arnaud Weber @author David Mendenhall

DisableChanges Swing's focus manager for the callingcurrent threadKeyboardFocusManager's thread group. Call thisdefault methodFocusTraversalPolicy ifto your applicationDefaultFocusTraversalPolicy. mixes@see java.awt components and swing's components.DefaultFocusTraversalPolicy Your@see applicationjava.awt.KeyboardFocusManager#setDefaultFocusTraversalPolicy will@deprecated then useas of the1.4 awt focusreplaced by managerKeyboardFocusManager.setDefaultFocusTraversalPolicy(FocusTraversalPolicy)

ReturnReturns the FocusManagercurrent KeyboardFocusManager instance for the calling thread's Therecontext. is@return onethis FocusManagerthread's percontext's KeyboardFocusManager thread@see group#setCurrentManager

ReturnReturns whether Swing'sthe focus manager isapplication has invoked enableddisableSwingFocusManager(). @see #disableSwingFocusManager @deprecated As of 1.4 replaced by KeyboardFocusManager.getDefaultFocusTraversalPolicy()

This method is called by JComponentsinitiates when a key eventfocus occurs.traversal JComponent gives key events tooperation if and only if the focusKeyEvent manager first then torepresents a focus traversal key listenersfor then to the keyboard UIspecified dispatcherfocusedComponent. This method should lookIt at theis key event and changeexpected that focusedComponent is the focused component if thecurrent key event matches thefocus owner although this receiver'sneed focus manager hot keysnot be the case. ForIf example the defaultit is not focus managertraversal will change the focusnevertheless proceed as if the key event matches TABfocusedComponent or Shift + TABwere the focus owner. The@param focus managerfocusedComponent should callthe Component consume()that onis anEventthe ifbasis anEventfor has beena focus processed.traversal focusedComponentoperation isif the component thatspecified currently has theevent represents a focus. Note: FocusManager will receive bothtraversal KEY_PRESSEDkey andfor KEY_RELEASEDthe keyComponent events.@param If onee the event is consumed thethat other one should be consumedmay represent a focus traversal too.key

SetSets the FocusManagercurrent thatKeyboardFocusManager should be usedinstance for the forcalling thread's context. If null is specified then the current KeyboardFocusManager is replaced with a new instance of DefaultKeyboardFocusManager.

If a SecurityManager is installed the calling thread must be granted the AWTPermission "replaceKeyboardFocusManager" in order to replace the the current KeyboardFocusManager. aFocusManagerIf this permission is not granted this method will bethrow a SecurityException and the defaultcurrent focusKeyboardFocusManager managerwill forbe unchanged. @param newManager the callingnew KeyboardFocusManager for this thread's threadcontext @see #getCurrentManager group@see java.awt.DefaultKeyboardFocusManager @throws SecurityException if the calling thread does not have permission to replace the current KeyboardFocusManager

This propertyfield is obsolete and its nameuse is useddiscouraged to getsince its specification is incompatible with the FocusManager1.4 implementationfocus thatAPIs. should be used forThe current FocusManager is no longer a givenproperty of the UI. Client code must query for the current FocusManager using KeyboardFocusManager.getCurrentKeyboardFocusManager(). See the Focus Specification for more information. @see java.awt.KeyboardFocusManager#getCurrentKeyboardFocusManager @see Focus Specification

An image filter that "disables" an image by turning it into a grayscale image and brightening the pixels in the image. Used by buttons to create an image for a disabled button. @author Jeff Dinkins @author Tom Ball @author Jim Graham @version 1.12 0213 12/0203/0001

An implementation of the Icon interface that paints Icons from Images. Images that are created from a URL or filename are preloaded using MediaTracker to monitor the loaded state of the image.

For further information and examples of using image icons see How to Use Icons in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @version 1.46 0449 12/0603/0001 @author Jeff Dinkins @author Lynn Monsanto

This class implements accessibility support for the ImageIcon class. It provides an implementation of the Java Accessibility API appropriate to image icon user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

InputMap provides a binding between an input event (currently only KeyStrokes are used) and an Object. InputMaps are usually used with an ActionMap to determine an Action to perform when a key is pressed. An InputMap can have a parent that is searched for bindings not defined in the InputMap.

As with ActionMap if you create a cycle eg:

 InputMap am = new InputMap(); InputMap bm = new InputMap(): am.setParent(bm); bm.setParent(am); 

some of the methods will cause a StackOverflowError to be thrown. @version 1.9 0211 12/0203/0001 @author Scott Violet @since 1.3

The purpose of this class is to help clients support smooth focus navigation through GUIs with text fields. Such GUIs often need to ensure that the text entered by the user is valid (for example that it's in the proper format) before allowing the user to navigate out of the text field. To do this clients create a subclass of InputVerifier and using JComponent's setInputVerifier method attach an instance of their subclass to the JComponent whose input they want to validate. Before focus is transfered to another Swing component that requests it the input verifier's shouldYieldFocus method is called. Focus is transfered only if that method returns true.

The following example has two text fields with the first one expecting the string "pass" to be entered by the user. If that string is entered in the first text field then the user can advance to the second text field either by clicking in it or by pressing TAB. However if another string is entered in the first text field then the user will be unable to transfer focus to the second text field.

 import java.awt.*; import java.util.*; import java.awt.event.*; import javax.swing.*; // This program demonstrates the use of the Swing InputVerifier class. // It creates two text fields; the first of the text fields expects the // string "pass" as input and will allow focus to advance out of it // only after that string is typed in by the user. public class VerifierTest extends JFrame { public VerifierTest () { JTextField tf; tftf1 = new JTextField ("TextField1Type \"pass\" here"); getContentPane().add (tftf1 BorderLayout.NORTH); tftf1.setInputVerifier(new PassVerifier()); tfJTextField tf2 = new JTextField ("TextField2"); getContentPane().add (tftf2 BorderLayout.SOUTH); addWindowListener (new MyWAdapter ()); } public static void main (String [] args) { FrameWindowListener fl = new VerifierTest (); f.pack(); f.showWindowAdapter(); } class MyWAdapter extends WindowAdapter { public void windowClosing(WindowEvent evente) { System.exit (0); } }; addWindowListener(l); } class PassVerifier extends InputVerifier { public boolean verify(JComponent input) { JTextField tf = (JTextField) input; Stringreturn "pass = ".equals(tf.getText()); if} (pass.equals} public static void main("pass")String[] args) return{ true;Frame else returnf = falsenew VerifierTest(); }f.pack(); f.setVisible(true); } } 

@since 1.3

An extended version of java.applet.Applet that adds support for the JFC/Swing component architecture. You can find task-oriented documentation about using JApplet in The Java Tutorial in the section How to Make Applets.

The JApplet class is slightly incompatible with java.applet.Applet. JApplet contains a JRootPane as it's only child. The contentPane should be the parent of any children of the JApplet. This is different than java.applet.Applet e.g. to add a child to an an java.applet.Applet you'd write:

 applet.add(child); 

However using JApplet you need to add the child to the JApplet's contentPane instead:

 applet.getContentPane().add(child); 

The same is true for setting LayoutManagers removing components listing children etc. All these methods should normally be sent to the contentPane() instead of the JApplet itself. The contentPane() will always be non-null. Attempting to set it to null will cause the JApplet to throw an exception. The default contentPane() will have a BorderLayout manager set on it.

Please see the JRootPane documentation for a complete description of the contentPane glassPane and layeredPane properties.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JApplet key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @beaninfo attribute: isContainer true attribute: containerDelegate getContentPane description: Swing's Applet subclass. @version 1.44 0853 12/0503/0001 @author Arnaud Weber

Creates a swing applet instance.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

By default the layout of this component may not be set the layout of its contentPane should be set instead. For example:

 thiComponentthisComponent.getContentPane().setLayout(new BorderLayoutGridLayout(1 2)) 

An attempt to set the layout of this component will cause an runtime exception to be thrown. Subclasses can disable this behavior. @see #setRootPaneCheckingEnabled @exception Error if called with rootPaneChecking true

Just calls paint(g). This method was overridden to prevent an unneccessaryunnecessary call to clear the background.

An implementation of a "push" button. See How to Use Buttons Check Boxes and Radio Buttons in The Java Tutorial for information and examples of using buttons.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JButton key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @beaninfo attribute: isContainer false description: An implementation of a \"push\" button. @version 1.84 0492 12/0603/0001 @author Jeff Dinkins

This class implements accessibility support for the JButton class. It provides an implementation of the Java Accessibility API appropriate to button user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Creates a button where properties are taken from the Action supplied. @param a the Action used to specify the new button @since 1.3

Creates a button with initial text and an icon. @param text the text of the button. @param icon the Icon image to display on the button

Factory method which sets the AbstractButton's properties according to values from the Action instance. The properties which get set may differ for AbstractButton subclasses. By default the properties which get set are Text Icon Enabled ToolTipText ActionCommand and ToolTipTextMnemonic. @param a the Action from which to get the properties or null @since 1.3 @see Action @see #setAction

Gets the AccessibleContext associated with this JButton. For JButtonsJButtons the AccessibleContext takes the form of an AccessibleJButton. A new AccessibleJButton instance is created if necessary. @return an AccessibleJButton that serves as the AccessibleContext of this JButton @beaninfo expert: true description: The AccessibleContext associated with this Button.

Returns a string that specifies the name of the L&F class that renders this component. @return the string "ButtonUI" @see JComponent#getUIClassID @see UIDefaults#getUI @beaninfo expert: true description: A string that specifies the name of the L&F class.

Returns whether orGets the value notof the defaultButton property which if true means that this button is the current default button for its JRootPane. Most look and feels render the default button ondifferently and may potentially provide bindings to access the RootPanedefault button. @return "boolean"the value of the defaultButton property @see JRootPane#setDefaultButton @see #isDefaultCapable @beaninfo description: Whether or not this button is the default button

ReturnsGets whether or notthe this button isvalue of the capabledefaultCapable ofproperty. being@return the default buttonvalue onof the RootPane. @returndefaultCapable "boolean"property @see #setDefaultCapable @see #isDefaultButton @see JRootPane#setDefaultButton

Returns a string representation of this JButton. 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. @return a string representation of this JButton.

Overrides JComponent.removeNotify to check if this button is currently set as the default button on the RootPane and if so sets the RootPane's default button to null to ensure the RootPane doesn't hold onto an invalid button reference.

Sets whetherthe ordefaultCapable notproperty which determines whether this button can be made the default button for its root pane. The default value of the defaultCapable property is true unless otherwise specified by the look and feel. @param defaultCapable true if this button will be capable of being the default button on the RootPane.; @returnotherwise "boolean"false @see #isDefaultCapable @beaninfo bound: true attribute: visualUpdate true description: Whether or not this button can be the default button

NotificationResets from the UIFactoryUI property to thata value from the L&Fcurrent look has changedand feel. @see JComponent#updateUI

An implementation of a check box -- an item that can be selected or deselected and which displays its state to the user. By convention any number of check boxes in a group can be selected. See How to Use Buttonc Check Boxes and Radio Buttons in The Java Tutorial for examples and information on using check boxes.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JCheckBox key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see JRadioButton @beaninfo attribute: isContainer false description: A component which can be selected or deselected. @version 1.59 0468 12/0603/0001 @author Jeff Dinkins

This class implements accessibility support for the JCheckBox class. It provides an implementation of the Java Accessibility API appropriate to check box user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Factory method which sets the ActionEvent source's properties according to values from the Action instance. The properties which are set may differ for subclasses. By default the properties which get set are Text IconMnemonic Enabled ActionCommand and ToolTipText. @param a the Action from which to get the properties or null @since 1.3 @see Action @see #setAction

Returns a string that specifies the name of the L&F class that renders this component. @return the string "CheckBoxUI" @see JComponent#getUIClassID @see UIDefaults#getUI @beaninfo expert: true description: A string that specifies the name of the L&F class

ReturnsGets whether the border should bevalue of the paintedborderPaintedFlat flatproperty. @return the value of the borderPaintedFlat property @see #setBorderPaintedFlat

Sets whetherthe borderPaintedFlat property which gives a hint to the border should be paintedlook and feel as flatto the appearance of the check box border. This is usually set to true when a JCheckBox instance is used as a renderer in a component such as a JTable or JTree. The default value for the borderPaintedFlat property is false. This method fires a property changed event. Some look and feels might not implement flat borders; they will ignore this property. @param b if true requests that the border isbe painted flat.; false requests normal borders @see #isBorderPaintedFlat @beaninfo bound: true attribute: visualUpdate true description: Whether the border is painted flat.

NotificationResets from the UIFactoryUI property to thata value from the L&Fcurrent look has changedand feel. @see JComponent#updateUI

A menu item that can be selected or deselected. If selected the menu item typically appears with a checkmark next to it. If unselected or deselected the menu item appears without a checkmark. Like a regular menu item a check box menu item can have either text or a graphic icon associated with it or both.

Either isSelected/setSelected or getState/setState can be used to determine/specify the menu item's selection state. The preferred methods are isSelected and setSelected which work for all menus and buttons. The getState and setState methods exist for compatibility with other component sets.

For further information and examples of using check box menu items see How to Use Menus a section in The Java Tutorial. For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JCheckBoxMenuItem key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @beaninfo attribute: isContainer false description: A menu item which can be selected or deselected. @version 1.48 0452 12/0603/0001 @author Georges Saab @author David Karlton

This class implements accessibility support for the JCheckBoxMenuItem class. It provides an implementation of the Java Accessibility API appropriate to checkbox menu item user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

JColorChooser provides a pane of controls designed to allow a user to manipulate and select a color. For information about using color choosers see How to Use Color Choosers a section in The Java Tutorial.

This class provides three levels of API:

1. A static convenience method which shows a modal color-chooser dialog and returns the color selected by the user.
2. A static convenience method for creating a color-chooser dialog where ActionListeners can be specified to be invoked when the user presses one of the dialog buttons.
3. The ability to create instances of JColorChooser panes directly (within any container). PropertyChange listeners can be added to detect when the current "color" property changes.

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. A futureAs release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @beaninfo attribute: isContainer false description: A component that supports selecting a Color. @version 1.30 0441 12/0603/0001 @author James Gosling @author Amy Fowler @author Steve Wilson

Adds a color chooser panel to the color chooser. @param panel the AbstractColorChooserPanel to be added

Creates and returns a new dialog containing the specified ColorChooser` pane along with "OK" "Cancel" and "Reset" buttons. If the "OK" or "Cancel" buttons are pressed the dialog is automatically hidden (but not disposed). If the "Reset" button is pressed the color-chooser's color will be reset to the color which was set the last time show was invoked on the dialog and the dialog will remain showing. @param c the parent component for the dialog @param title the title for the dialog @param modal a boolean. When true the remainder of the program is inactive until the dialog is closed. @param chooserPane the color-chooser to be placed inside the dialog @param okListener the ActionListener invoked when "OK" is pressed @param cancelListener the ActionListener invoked when "Cancel" is pressed @return a new dialog containing the color-chooser pane @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless

Returns the specified color panels. @return an array of AbstractColorChooserPanel objects

Returns the preview panel that shows a chosen color. @return a JComponent object -- the preview panel

Returns the data model that handles color selections. @return a ColorSelectionModel object

Returns the L&F object that renders this component. @return the ColorChooserUI object that renders this component

Removes the Color Panel specified. @exception IllegalArgumentException if panel is not in list of known chooser panels @param name a string that specifies the panel to be removed @return the color panel @exception IllegalArgumentException if panel is not in list of known chooser panels

Specifies the Color Panels used to choose a color value. @param panels an array of AbstractColorChooserPanel objectobjects @beaninfo bound: true hidden: true description: An array of different chooser types.

Sets the current color of the color chooser to the specified color. ThisThe ColorSelectionModel will fire a PropertyChangeEventChangeEvent for the property named "color". @param color the color to be set in the color chooser @see JComponent#addPropertyChangeListener @beaninfo bound: false hidden: false description: The current color the chooser is to display.

Sets the current color of the color chooser to the specified color. @param c an intinteger value that sets the current color in the chooser where the low-order 8 bits specify the Blue value the next 8 bits specify the Green value and the 8 bits above that specify the Red value.

SetSets the model containing the selected color. @param newModel the new ColorSelectionModel object @beaninfo bound: true hidden: true description: The model which contains the currently selected color.

Sets the L&F object that renders this component. @param ui the ColorChooserUI L&F object @see UIDefaults#getUI @beaninfo bound: true hidden: true description: The UI object that implements the color chooser's LookAndFeel.

Shows a modal color-chooser dialog and blocks until the dialog is hidden. If the user presses the "OK" button then this method hides/disposes the dialog and returns the selected color. If the user presses the "Cancel" button or closes the dialog without pressing "OK" then this method hides/disposes the dialog and returns null. @param component the parent Component for the dialog @param title the String containing the dialog's title @param initialColor the initial Color set when the color-chooser is shown @return the selected color or null if the user opted out @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless

A component that combines a button or texteditable field and a drop-down list. The user can select a value from the drop-down list which appears at the user's request. If you make the combo box editable then the combo box includes aan texteditable field into which the user can type a value. For examples and information on using combo boxes see How to Use Combo Boxes a section in The Java Tutorial.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JComboBox key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

See How to Use Combo Boxes in The Java Tutorial for further information.

@see ComboBoxModel @see DefaultComboBoxModel @beaninfo attribute: isContainer false description: A combination of a text field and a drop-down list. @version 1.82 02112 12/0920/01 @author Arnaud Weber @author Mark Davidson

This class implements accessibility support for the JComboBox class. It provides an implementation of the Java Accessibility API appropriate to Combo Box user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Adds an ActionListener.

The listenerActionListener will receive an actionActionEvent when a selection has been made. eventIf the usercombo finishes making abox is editable selectionthen an ActionEvent will be fired when editing has stopped. @param l the ActionListener that is to be notified @see #setSelectedItem

Adds an item to the item list. This method works only if the JComboBox uses the default data model. JComboBox usesa the defaultmutable data model when created with the empty constructor and no other model has been set.

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

@param anObject the Object to add to the list @see MutableComboBoxModel

Adds an ItemListener.

aListener will receive anone or eventtwo ItemEvents when the selected item changes. @param aListener the ItemListener that is to be notified @see #setSelectedItem

This method is public as an implementation side effect. do not call or override. @see javax.swing.event.ListDataListener

Notifies all listeners that have registered interest for notification on this event type. @param e the event of interest @see EventListenerList

Returns the currentlycurrent selected item. @return

If the currentlycombo selectedbox is editable then this value may not have been added to the list object fromcombo box with addItem insertItemAt or the data modelconstructors. @return the current selected Object @see #setSelectedItem

Returns an array containing the selected item. This method is implemented for compatibility with ItemSelectable. @returnsreturn an array of Objects containing one element -- the selected item

Inserts an item into the item list at a given index. This method works only if the JComboBox uses the default data model. JComboBox uses thea defaultmutable data model when created with the empty constructor and no other model has been set. @param anObject the Object to add to the list @param index an integer specifying the position at which to add the item @see MutableComboBoxModel

Invoked items have been added to the internalThis method is public as an implementation side data modeleffect. The "interval" includes the firstdo and last valuesnot call or added. @see javax.swing.eventoverride.ListDataListener

Invoked when values have been removed from theThis method is public as an implementation side data modeleffect. The "interval" includes the firstdo and last valuesnot call or removed. @see javax.swing.eventoverride.ListDataListener

Returns true ifwhether thethis componentComponent can receivebecome the focus. In this case the componentowner. returns@return falsetrue if it is editable so that thethis EditorComponent objectis receivesfocusable; thefalse focusotherwise instead@see of#setFocusable the@since componentJDK1.1 @return truedeprecated if the componentAs can receiveof the1.4 focus elsereplaced by falseisFocusable().

Returns true if lightweightGets the value of (all-Java)the popupslightWeightPopupEnabled are in use or false if heavyweight (native peer) popups are being usedproperty. @return truethe value if lightweightof the popupslightWeightPopupEnabled areproperty in@see use#setLightWeightPopupEnabled

Determines the visibility of the popup. @return true if the popup is visible otherwise returns false

Removes an item from the item list. This method works only if the JComboBox uses the default data model. JComboBox usesa the defaultmutable data model when created with the empty constructor and no other model has been set. @param anObject the object to remove from the item list @see MutableComboBoxModel

Removes the item at anIndex This method works only if the JComboBox uses the default data model. JComboBox usesa the defaultmutable data model when created with the empty constructor and no other model has been set. @param anIndex an int specifying the idexindex of the item to remove where 0 indicates the first item in the list @see MutableComboBoxModel

Selects the list item that correpondscorresponds to the specified keyboard character and returns true if there is an item corresponding to that character. Otherwise returns false. @param keyChar a char typically this is a keyboard key typed by the user

This protected method is called when the selected itemimplementation changesspecific. ItsDo default implementationnot notifies the item listenersaccess directly or override.

Sets the Action for the ActionEvent source. The new Action replaces any previously set Action but does not affect ActionListeners independantlyindependently added with addActionListener. If the Action is already a registered ActionListener for the ActionEvent source it is not re-registered.

A side-effect of setting the Action is that the ActionEvent source's properties are immedately set from the values in the Action (performed by the method configurePropertiesFromAction) and subsequently updated as the Action's properties change (via a PropertyChangeListener created by the method createActionPropertyChangeListener. @param a the Action for the JComboBox or null. @since 1.3 @see Action @see #getAction @see #configurePropertiesFromAction @see #createActionPropertyChangeListener @beaninfo bound: true attribute: visualUpdate true description: the Action instance connected with this ActionEvent source

Sets the action commnandcommand that should be included in the event sent to action listeners. @param 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

WhenSets displaying the popuplightWeightPopupEnabled property which provides a hint as to whether or not a lightweight JComboBoxComponent chooseshould be used to usecontain the JComboBox versus a lightheavyweight weightComponent popupsuch ifas a Panel or ita fitsWindow. This method allows you to disableThe decision of lightweight versus heavyweight thisis ultimately up to the featureJComboBox. You haveLightweight windows toare more efficient than heavyweight windows but lightweight and heavyweight components do disable itnot mix ifwell in a GUI. If your application mixes lightlightweight and heavyweight components you should disable lightweight popups. The default value for the lightWeightPopupEnabled property is true unless otherwise specified weightby the look and heavyfeel. weightsSome componentslook and feels always use heavyweight popups no matter what the value of this property.

See the article Mixing Heavy and Light Components on The Swing Connection This method fires a property changed event. @param aFlag if true lightweight popups are desired @beaninfo bound: true expert: true description: When setSet to disablesfalse using light weightto require heavyweight popups.

Sets the renderer that paints the list items and the item selected from the list in the JComboBox field. The renderer is used if the JComboBox is not editable. If it is editable the editor is used to render and edit the selected item.

The default renderer displays a string obtained by callingor the selected object's toStringan methodicon. 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. @param aRenderer the ListCellRenderer that displays the selected item @see #setEditor @beaninfo bound: true expert: true description: The renderer that paints the item selected in the list.

Selects the item at index anIndex. @param anIndex an integer specifying the list item to select where 0 specifies the first item in the list and -1 indicates no selection @exception IllegalArgumentException if anIndex <-1 or anIndex is greater than or equal to size @beaninfo preferred: true description: The item at index is selected.

Sets the selected item in the JComboBoxcombo box by specifyingdisplay area to the object in the listargument. If anObject is in the list the display area shows anObject selected.

If anObject is not in the list displaysand 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. @param anObject the list object to select; use null to clear the selection @beaninfo preferred: true description: Sets the selected item in the JComboBox.

Sets the L&F object that renders this component. @param ui the ComboBoxUI L&F object @see UIDefaults#getUI @beaninfo expertbound: true hidden: true attribute: visualUpdate true description: The ComboBoxUI implementationUI object that definesimplements the combo box look andComponent's feelLookAndFeel.

NotificationResets from the UIFactoryUI property to thata value from the L&Fcurrent look has changedand feel. @see JComponent#updateUI

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 javax.swing.plaf.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 and #getClientProperty 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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see KeyStroke @see Action @see #setBorder @see #registerKeyboardAction @see JOptionPane @see #setDebugGraphicsOptions @see #setToolTipText @see #setAutoscrolls @version 2.130 07/09/99 @author Hans Muller @author Arnaud Weber

Inner class of JComponent used to provide default support for accessibility. This class is not meant to be used directly by application developers but is instead meant only to be subclassed by component developers.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Default JComponent constructor. This constructor does novery 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 #getDefaultLocale

Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible /or invisible. Events are also sent when the component or its ancestors are added or removed from the containment hierarchy. @param listener the AncestorListener to register @see AncestorEvent

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

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

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

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

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

If listener is null no exception is thrown and no action is performed. @param propertyName the name of the property to listen on @param listener the PropertyChangeListener to be added

Adds a VetoableChangeListener to the listener list. The listener is registered for all properties. @param listener the VetoableChangeListener to be added

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. @param 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 #getVisibleRect

Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing. @return true if this component logically contains x y @see java.awt.Component#contains(int int) @see ComponentUI

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. @return the JToolTip used to display this toolTip

overriddenOverridden to ensure Accessibility support. Please use {@alink java.awt.Component.setEnable(boolean)}.

overriddenOverridden to ensure Accessibility support. Please use {@alink java.awt.Component.setEnable(boolean)}.

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

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

@param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as an Object) @param newValue the new value of the property (as an Object) @see java.beans.PropertyChangeSupport

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a boolean) @param oldValue the old value of the property (as a boolean) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a byte) @param newValue the new value of the property (as a byte) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a char) @param newValue the new value of the property (as a char) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a double) @param newValue the new value of the property (as a double) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a float) @param newValue the new value of the property (as a float) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as an int) @param newValue the new value of the property (as an int) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a long) @param newValue the new value of the property (as a long) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Reports a bound property change. @param propertyName the programmatic name of the property that was changed @param oldValue the old value of the property (as a short) @param newValue the old value of the property (as a short) @see #firePropertyChange(java.lang.String java.lang.Object java.lang.Object)

Supports reporting constrained property changes. This method can be called when a constrained property has changed and it will send the appropriate PropertyChangeEvent to any registered VetoableChangeListeners. @param propertyName the name of the property that was listened on @param oldValue the old value of the property @param newValue the new value of the property @exception PropertyVetoException when the attempt to set the property is vetoed by the receiver.component

GetsReturns 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. @return the AccessibleContext of this JComponent

Returns the object that will perform the action registered for a given keystroke. @return the ActionListener object invoked when the keystroke occurs

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. @return the ActionMap containing the key/action bindings @since 1.3

Overrides Container.getAlignmentX to return the vertical alignment. @return the value of the alignmentX property @see #setAlignmentX @see java.awt.Component#getAlignmentX

Overrides Container.getAlignmentY to return the horizontal alignment. @return the value of the alignmentY property @see #setAlignmentY @see java.awt.Component#getAlignmentY

ReturnsGets truethe ifautoscrolls this component automatically scrolls its contents when dragged (when contained inproperty. a@return component that supports scrollingthe value of the likeautoscrolls JViewport).property @see JViewport @see #setAutoscrolls

Returns the border of this component or null if no border is currently set. @return the border object for this component @see #setBorder

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. @param rv the return value modified to the component's bounds @return rv; if rv is null return a newly created Rectangle with this component's bounds

Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value. @param key the being queried @return the value of this property or null @see #putClientProperty

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. @param g the original Graphics object @return a Graphics object configured for this component

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. @return the action-keystroke condition

Returns the state of graphics debugging. @return 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 #setDebugGraphicsOptions

Returns this component's graphics context which lets you draw on a component. Use this method get a Graphics object and then invoke oeprationsoperations on that object to draw on the component. @return this components graphics context

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. @return the current height of this component.

Returns the InputMap that is used when the receivercomponent has focus. This is convenience method for getInputMap(WHEN_FOCUSED). @return the InputMap used when the component has focus @since JDK1.3

Returns the InputMap that is used during condition. @param condition one of WHEN_IN_FOCUSED_WINDOW WHEN_FOCUSED WHEN_ANCESTOR_OF_FOCUSED_COMPONENT @return the InputMap for the specified condition @since 1.3

Returns the input verifier for this component. @return the inputVerifier property @since 1.3 @see InputVerifier

If a border has been set on this component returns the border's insets; otherwise calls super.getInsets. @return the value of the insets property @see #setBorder

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. @param insets the Insets object which can be reused @return the Insets object @see #getInsets @beaninfo expert: true

ReturnReturns an array of all the listenersobjects that werecurrently registered addedas FooListeners toupon this JComponent with. addXXXListener()FooListeners where XXX isare registered using the nameaddFooListener ofmethod.

You can specify the listenerType argument with a class literal such as FooListener.class. For example to get all ofyou can query a theJComponent MouseListenersc for the given Componentits mouse listeners cwith one would writethe following code:

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

If no such listenerlisteners exist list exists thenthis method returns an empty array. @param listenerType the type of listeners requested; this isparameter returnedshould specify an interface that descends from java.util.EventListener @returns allreturn an array of the listenersall objects forregistered as FooListeners on this JComponentcomponent or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @since 1.3 @see #getVetoableChangeListeners @see #getAncestorListeners

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. @param rv the return value modified to the component's location @return rv

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. @return the value of the maximumSize property. @see #setMaximumSize @see ComponentUI

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. @return the value of the minimumSize property @see #setMinimumSize @see ComponentUI

Returns the nextComponent focusable componentset by a prior call to setNextFocusableComponent(Component) on this JComponent. @return the Component that will follow this JComponent in the focus traversal cycle or null if the focus manager should choosenone has been explicitly specified the@see #setNextFocusableComponent next@deprecated As of 1.4 focusable componentreplaced by automaticallyFocusTraversalPolicy.

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. @return the value of the preferredSize property @see #setPreferredSize @see ComponentUI

Returns the KeyStrokes that will initiate registered actions. @return an array of KeyStroke objects @see #registerKeyboardAction

Returns the JRootPane ancestor for athis component. @return the JRootPane that contains this component or null if no JRootPane is found

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. @param rv the return value modified to the component's size @return rv

Returns the tooltip location in this component's coordinate system. If null is returned Swing will choose a location. The default implementation returns null. @param event the MouseEvent that caused the ToolTipManager to show the tooltip @return always returns null

Returns the tooltip string that has been set with setToolTipText(). @return the text of the tool tip @see #TOOL_TIP_TEXT_KEY

Returns the string to be used as the tooltip for event. By default this returns any string set using setToolTipText(). If a component provides more extensive API to support differing tooltips at different locations this method should be overridden.

Returns the top-level ancestor of this component (either the containing Window or Applet) or null if this component has not been added to any container. @return the top-level Container that this component is in or null if not in any container

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. @return Thethe UIDefaults key for a ComponentUI subclass. @see UIDefaults#getUI @beaninfo expert: true description: UIClassID

GetReturns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus. @return value of the verifyInputWhenFocusTarget property @see InputVerifier @see #setInputVerifier @see #getInputVerifier @see #setVerifyInputWhenFocusTarget @since 1.3

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 Rectanglesrectangles. @return the visible rectangle

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. @return the current width of this component.

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

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. @return the current y coordinate of the component's origin

SetsRequests that this Component get the input focus onand that this Component's top-level ancestor become the receivingfocused Window. This component if itmust be doesn'tdisplayable already havevisible and itfocusable for the request to be granted.

This method is intended for use by focus managersimplementations. YouClient rarely want to callcode should not use this method; instead it should use requestFocus() instead. @see #requestFocus()

Returns true if this Component hasis the keyboard focus owner. This method is obsolete and has been replaced by isFocusOwner(). @return true if this Component hasis the keyboard focus owner; false otherwise @since 1.2

Returns whether thethis receiving component should use a buffer to paint. @return true if this component is double buffered otherwise false

IdentifiesReturns whether or not this componentComponent can receivebecome the focus owner. A@return disabledtrue button forif this exampleComponent wouldis returnfocusable; false. otherwise @returnsee true#setFocusable if@since thisJDK1.1 component@deprecated can receiveAs of the1.4 focusreplaced by isFocusable().

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

OverrideChanges this method and return true if your JComponent manages focus. If your component manages focus the's focus manager will handletraversal keys to yourCTRL+TAB component'sand childrenCTRL+SHIFT+TAB. All keyAlso prevents eventSortingFocusTraversalPolicy will be sent to your key listener including TAB andfrom considering descendants of this JComponent when computing a focus SHIFT+TABtraversal cycle. CONTROL+TAB@see andjava.awt.Component#setFocusTraversalKeys CONTROL+SHIFT+TAB@see willSortingFocusTraversalPolicy move@deprecated the focusAs of to1.4 the nextreplaced by orComponent.setFocusTraversalKeys(int Set) previousand componentContainer.setFocusCycleRoot(boolean).

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

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

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

Returns true if the receiving 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. @return true if the component is currently painting a tile false otherwise

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

Returns whethertrue the receivingif this component canJComponent obtain theshould get focus; by callingotherwise returns requestFocusfalse. @return true if this component should get focus otherwise returns false @see #setRequestFocusEnabled @see Focus Specification @see java.awt.Component#isFocusable

If this method returns true revalidate() calls by descendants of this component will cause the entire tree beginning with this root to be validated. Returns false by default. JScrollPane overrides this method and returns true. @return always returns false @see #revalidate @see java.awt.Component#invalidate @see java.awt.Container#validate

This method isInvoked 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. @param g the Graphics context in which to paint @see #paintComponent @see #paintBorder @see #paintChildren @see #getComponentGraphics @see #repaint

Paints the component's border.

If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it. @param g the Graphics context in which to paint @see #paint @see #setBorder

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. @param g the Graphics context in which to paint @see #paint @see java.awt.Container#paint

IfCalls the UI delegate's ispaint non-nullmethod calls its paintif the UI methoddelegate 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. @param g the Graphics object to protect @see #paint @see ComponentUI

Paints the specified region now. @param r a Rectangle containing the region to be painted

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

It's rarely necessary to call this method. In most cases it's more efficient to call repaint which defers the actual painting and can collapse redundant requests into a single paint call. This method is useful if one needs to update the display while the current event is being dispatched. @param x the x value of the region to be painted @param y the y value of the region to be painted @param w the width of the region to be painted @param h the height of the region to be painted @see #repaint

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

Invoke this method to print the receivercomponent. 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 metionedmentioned methods. This method sets the receiverscomponent's state such that the double buffer will not be used eg painting will be done directly on the passed in Graphics. @param g the Graphics context in which to paint @see #printComponent @see #printBorder @see #printChildren

Invoke this method to print the receivercomponent. This method invokes print on the receivercomponent. @param g the Graphics context in which to paint @see #print @see #printComponent @see #printBorder @see #printChildren

Prints the component's border. This is implemented to invoke paintBorder on the receivercomponent. OverridesOverride this if you wish to print the border differently that it is painted. @param g the Graphics context in which to paint @see #print @since 1.3

Prints this component's children. This is implemented to invoke paintChildren on the receivercomponent. Override this if you wish to print the children differently than painting. @param g the Graphics context in which to paint @see #print @since 1.3

This is invoked during a printing operation. This is implemented to invoke paintComponent on the receivercomponent. Override this if you wish to add special painting behavior when printing. @param g the Graphics context in which to paint @see #print @since 1.3

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 receivercomponent is enabled) invokes notifyAction to notify the action. @param ks the KeyStroke queried @param e the KeyEvent @param condition one of the following values:

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

@param pressed true if the key is pressed @return true if there was a binding to an action and the action was enabled @since 1.3

Overrides processKeyEvent to process events.

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. @param key the new client property key @param value the new client property value; if null this method will remove the property @see #getClientProperty @see #addPropertyChangeListener

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 ConditionaCondition 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. @param anAction the Action to be registered @param aCommand the command to be set in the delivered event @param aKeyStroke the KeyStroke to bind to the action @param aCondition the condition that needs to be met see above @see KeyStroke

Unregisters listener so that it will no longer receive AncestorEvents. @param listener the AncestorListener to be removed @see #addAncestorListener

Notifies this component that it no longer has a parent component. When this method is invoked any KeyboardActionsKeyboardActions set up in the the chain of parent components are removed. @see #registerKeyboardAction

Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. @param listener the PropertyChangeListener to be removed

Removes a PropertyChangeListener for a specific property. If listener is null no exception is thrown and no action is performed. @param propertyName the name of the property that was listened on @param listener the PropertyChangeListener to be removed

Removes a VetoableChangeListener from the listener list. This removes a VetoableChangeListener that was registered for all properties. @param listener the VetoableChangeListener to be removed

Adds the specified region to the dirty region list if the component is showing. The component will be repainted after all of the currently pending events have been dispatched. @param r a Rectangle containing the dirty region @see java.awt.Component#isShowing @see RepaintManager#addDirtyRegion

Adds the specified region to the dirty region list if the component is showing. The component will be repainted after all of the currently pending events have been dispatched. @param tm this parameter is not used @param x the x value of the dirty region @param y the y value of the dirty region @param width the width of the dirty region @param height the height of the dirty region @see java.awt.Component#isShowing @see RepaintManager#addDirtyRegion

Requests the focus for theon this componentJComponent's FocusTraversalPolicy's thatdefault shouldComponent. have theIf this focusJComponent byis default.a The default implementation will recursivelyfocus cycle root then its requestFocusTraversalPolicy theis focusused. onOtherwise the firstFocusTraversalPolicy component thatof this isJComponent's focus-traversable.cycle-root @returnancestor falseis ifused. the@see focusjava.awt.FocusTraversalPolicy#getDefaultComponent has@deprecated not beenAs of set1.4 otherwise returnreplaced by trueFocusTraversalPolicy.getDefaultComponent(Container).requestFocus()

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.

Moves and resizes this component. @param x the new horizontal location @param y the new vertical location @param w the new width @param h the new height @see java.awt.Component#setBounds

Supports deferred automatic layout.

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

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

@see java.awt.Component#invalidate @see java.awt.Container#validate @see #isValidateRoot @see RepaintManager#addInvalidComponent

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. @param aRect the visible Rectangle @see JViewport

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. @param am the new ActionMap @since 1.3

Sets the the vertical alignment. @param alignmentX the new vertical alignment @see #getAlignmentX @beaninfo description: The preferred horizontal alignment of the component.

Sets the the horizontal alignment. @param alignmentY the new horizontal alignment @see #getAlignmentY @beaninfo description: The preferred vertical alignment of the component.

Sets the autoscrolls property. If true this component will automatically scroll its contentsmouse dragged events will be synthetically generated when the mouse is dragged ifoutside 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 containedthe 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 supportscalls scrollRectToVisible. scrolling such asFor example given JViewporta 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. @seeparam JViewportautoscrolls 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 #getAutoscrolls @see JViewport @see JScrollPane @beaninfo expert: true description: WhetherDetermines if this component automatically scrolls its contents when dragged.

Sets the background color of this component. @param bg the desired background Color @see java.awt.Component#getBackground @beaninfo preferred: true bound: true attribute: visualUpdate true description: The background color of the component.

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. @param border the border to be rendered for this component @see Border @see CompoundBorder @beaninfo bound: true preferred: true attribute: visualUpdate true description: The component's border.

Enables or disables diagnostic information about every graphics operation performed within the component or one of its children. The value of@param debugOptions determines how the component should display thisthe 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. debug is bitwise OR'd into the current value.
• 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 @beaninfo preferred: true enum: NONE_OPTION DebugGraphics.NONE_OPTION LOG_OPTION DebugGraphics.LOG_OPTION FLASH_OPTION DebugGraphics.FLASH_OPTION BUFFERED_OPTION DebugGraphics.BUFFERED_OPTION description: Diagnostic options for graphics operations.

Sets whether the receivingthis component should use a buffer to paint. If set to true all the drawing from this component will be done in an offscreen painting buffer. The offscreen painting buffer will the be copied onto the screen. Swing'sSwings painting system always useuses a maximum of one double buffer. If a Component is buffered and one of its ancestor is also buffered the ancestor buffer will be used. @param aFlag if true set this component to be double buffered

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. @param enabled true if this component should be enabled false otherwise @see java.awt.Component#isEnabled @see java.awt.Component#isLightweight @beaninfo preferred: true bound: true attribute: visualUpdate true description: The enabled state of the component.

Sets the font for this component. @param the desired Font for this component @see java.awt.Component#getFont @beaninfo preferred: true bound: true attribute: visualUpdate true description: The font for the component.

Sets the foreground color of this component. @param fg the desired foreground Color @see java.awt.Component#getForeground @beaninfo preferred: true bound: true attribute: visualUpdate true description: The foreground color of the component.

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). Conditioncondition ishas one of the following values:

• WHEN_IN_FOCUSED_WINDOW
• WHEN_FOCUSED or
• 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 justlisted mentioned an IllegalArgumentException will be thrown. @param condition one of the values listed above @param map the InputMap to use for the given condition @exception IllegalArgumentException if condition is WHEN_IN_FOCUSED_WINDOW WHEN_FOCUSEDand WHEN_ANCESTOR_OF_FOCUSED_COMPONENTmap is not an instance of ComponentInputMap; or if condition is not one of the legal values specified above @since 1.3

Sets the input verifier for this component. @param inputVerifier the new input verifier @since 1.3 @see InputVerifier @beaninfo bound: true description: The component's input verifier.

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. @param maximumSize a Dimension containing the desired maximum allowable size @see #getMaximumSize @beaninfo bound: true description: The maximum size of the component.

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. @param minimumSize the new minimum size of this component @see #getMinimumSize @beaninfo bound: true description: The minimum size of the component.

SpecifiesOverrides the nextdefault componentFocusTraversalPolicy to getfor this theJComponent's focus after this onetraversal cycle by forunconditionally setting the specified exampleComponent whenas the tabnext Component key isin the pressed.cycle Invokeand this methodJComponent toas override the defaultspecified focus-changeComponent's previous Component in the sequencecycle. @beaninfoparam expert:aComponent truethe description:Component Thethat nextshould follow componentthis JComponent to getin the focus aftertraversal thiscycle @see #getNextFocusableComponent @see java.awt.FocusTraversalPolicy @deprecated oneAs of 1.4 replaced by FocusTraversalPolicy

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. @param isOpaque true if this component should be opaque @see #isOpaque @beaninfo bound: true expert: true description: The component's opacity

Sets the preferred size of the receivingthis component. If preferredSize is null the UI will be asked for the preferred size. @beaninfo preferred: true bound: true description: The preferred size of the component.

SetsProvides a hint as to whether the receiving componentor not this canJComponent obtain theshould get focus. by callingThis is requestFocus.only The defaulta hint valueand it is true.up to consumers that are requesting focus Note:to Settinghonor this property. toThis is typically honored false willfor mouse operations but not preventkeyboard theoperations. focus manager from setting the focus toFor example look and feels could verify this componentproperty it will prevent the component from gettingis true before requesting focus during a themouse operation. This would often times be used if you did not want a mouse press on a JComponent to steal focus whenbut did want the focusJComponent isto be traversable requestedvia explicitlythe keyboard. Override isFocusTraversable and return false ifIf you do not want this theJComponent component should never getfocusable at all use the focussetFocusable method instead. @beaninfoparam expert:requestFocusEnabled trueIndicates if description:you Whetherwant thethis JComponent component can obtain theto be focusable or focusnot @see byFocus callingSpecification requestFocus@see java.awt.Component#setFocusable

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. @param text the string to display; if the text is null the tool tip is turned off for this component @see #TOOL_TIP_TEXT_KEY @beaninfo preferred: true description: The text to display in a tool tip.

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

@param newUI the new UI delegate @see #updateUI @see UIManager#getLookAndFeel @see UIManager#getUI @beaninfo bound: true hidden: true attribute: visualUpdate true description: The component's look and feel delegate.

SetSets 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. @param newflag value for the verifyInputWhenFocusTarget property @see InputVerifier @see #setInputVerifier @see #getInputVerifier @see #getVerifyInputWhenFocusTarget @since 1.3 @beaninfo bound: true description: Whether the Component verifies input before accepting focus.

Makes the component visible or invisible. Overrides Component.setVisible. @param aFlag true to make the component visible; false to make it invisible @beaninfo attribute: visualUpdate true

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

Calls paint(g). Doesn't clear the background but see ComponentUI.update() which is called by paintComponent. @param g the Graphics context in which to paint @see #paint @see #paintComponent @see javax.swing.plaf.ComponentUI

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 #setUI @see UIManager#getLookAndFeel @see UIManager#getUI

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.

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

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.

The AccessibleContext associated with this JComponent.

A container used to create a multiple-document interface or a virtual desktop. You create JInternalFrame objects and add them to the JDesktopPane. JDesktopPane extends JLayeredPane to manage the potentially overlapping internal frames. It also maintains a reference to an instance of DesktopManager that is set by the UI class for the current Looklook and Feelfeel (L&F). Note that JDesktopPane does not support borders.

This class is normally used as the parent of JInternalFrames to provide a pluggable DesktopManager object to the JInternalFrames. The installUI of the L&F specific implementation is responsible for setting the desktopManager variable appropriately. When the parent of a JInternalFrame is a JDesktopPane it should delegate most of its behavior to the desktopManager (closing resizing etc).

For the keyboard keys used by this component in the standard Looklook and Feelfeel (L&F) renditions see the JDesktopPane key assignments. For further documentation and examples see How to Use Internal Frames a section in The Java Tutorial.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see JInternalFrame @see JInternalFrame.JDesktopIcon @see DesktopManager @version 1.37 0444 12/0603/0001 @author David Kloba

This class implements accessibility support for the JDesktopPane class. It provides an implementation of the Java Accessibility API appropriate to desktop pane user-interface elements.

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. AAs future release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder

Creates a new JDesktopPane.

Gets the AccessibleContext associated with this JDesktopPane. For desktop panes the AccessibleContext takes the form of an AccessibleJDesktopPane. A new AccessibleJDesktopPane instance is created if necessary. @return an AccessibleJDesktopPane that serves as the AccessibleContext of this JDesktopPane

Returns all JInternalFrames currently displayed in the desktop. Returns iconified frames as well as expanded frames. @return an array of JInternalFrame objects

Returns all JInternalFrames currently displayed in the specified layer of the desktop. Returns iconified frames as well expanded frames. @param layer an int specifying the desktop layer @return an array of JInternalFrame objects @see JLayeredPane

Returns the DesktopManger that handles desktop-specific UI actions. @param d the DesktopManager currently in use

GetGets the current "dragging style" used by the desktop pane. @return either Live_DRAG_MODE or OUTLINE_DRAG_MODE @see #setDragMode

returnReturns the currently active JInternalFrame in this JDesktopPane or null if no JInternalFrame is currently active. @return the currently active JInternalFrame or null @since 1.3

Returns the L&F object that renders this component. @return the DesktopPaneUI object that renders this component

Returns the name of the L&F class that renders this component. @return the string "DesktopPaneUI" @see JComponent#getUIClassID @see UIDefaults#getUI

Returns a string representation of this JDesktopPane. 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. @return a string representation of this JDesktopPane.

Sets the DesktopManger that will handle desktop-specific UI actions. @param d the DesktopManager to use

SetSets the "dragging style" used by the desktop pane. You may want to change to one mode or another for performance or aesthetic reasons. @param dragMode the style of drag to use for items in the Desktop @see #LIVE_DRAG_MODE @see #OUTLINE_DRAG_MODE @beaninfo bound: true description: Dragging style for internal frame children. enum: LIVE_DRAG_MODE JDesktopPane.LIVE_DRAG_MODE OUTLINE_DRAG_MODE JDesktopPane.OUTLINE_DRAG_MODE

setSets the currently active JInternalFrame in this JDesktopPane. @param f Thethe internal frame that's currently selected @since 1.3

Sets the L&F object that renders this component. @param ui the DesktopPaneUI L&F object @see UIDefaults#getUI @beaninfo bound: true hidden: true attribute: visualUpdate true description: The UI object that implements the Component's LookAndFeel.

Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager. @see JComponent#updateUI

Used toIndicates that indicate you wish to see the entire contents of the item being dragged should appear inside the desktop pane. @see #OUTLINE_DRAG_MODE @see #setDragMode

Used toIndicates that indicate you wish to see only an outline only of the item being dragged should appear inside the desktop pane. @see #LIVE_DRAG_MODE @see #setDragMode

The main class for creating a dialog window. You can use this class to create a custom dialog or invoke the many class methods in JOptionPane to create a variety of standard dialogs. For information about creating dialogs see The Java Tutorial section How to Make Dialogs.

The JDialog component contains a JRootPane as its only child. The contentPane should be the parent of any children of the JDialog. From the older java.awt.Window object you would normally do something like this:

 dialog.add(child); 

Using JDialog the proper semantic is:

 dialog.getContentPane().add(child); 

The same prinicipleprinciple holds true for setting layout managers removing components listing children etc. All these methods should normally be sent to the contentPane instead of to the JDialog. The contentPane is always non-null. Attempting to set it to null generates an exception. The default contentPane has a BorderLayout manager set on it.

Please see the JRootPane documentation for a complete description of the contentPane glassPane and layeredPane components.

In a multi-screen environment you can create a JDialog on a different screen device than its owner. See java.awt.Frame for more information.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JDialog key assignments.

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. A future releaseAs of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @see JOptionPane @see JRootPane @beaninfo attribute: isContainer true attribute: containerDelegate getContentPane description: A toplevel window for creating dialog boxes. @version 1.53 0866 12/0503/0001 @author David Kloba @author James Gosling @author Scott Violet

Creates a non-modal dialog without a title and without a specified Frame owner. A shared hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a non-modal dialog without a title with the specifedspecified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the non-null Dialog from which the dialog is displayed @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a non-modal dialog with the specified title and with the specified owner dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the non-null Dialog from which the dialog is displayed @param title the String to display in the dialog's title bar @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a modal or non-modal dialog with the specified title and the specified owner frame.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the non-null Dialog from which the dialog is displayed @param title the String to display in the dialog's title bar @param modal true for a modal dialog false for one that allows other windows to be active at the same time @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a modal or non-modal dialog without a title and with the specified owner dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the non-null Dialog from which the dialog is displayed @param modal true for a modal dialog false for one that allows other windows to be active at the same time @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a non-modal dialog without a title with the specifedspecified Frame as its owner. If owner is null a shared hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the Frame from which the dialog is displayed @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a non-modal dialog with the specified title and with the specified owner frame. If owner is null a shared hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the Frame from which the dialog is displayed @param title the String to display in the dialog's title bar @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a modal or non-modal dialog with the specified title and the specified owner Frame. If owner is null a shared hidden frame will be set as the owner of this dialog. All constructors defer to this one.

NOTE: Any popup components (JComboBox JPopupMenu JMenuBar) created within a modal dialog will be forced to be lightweight.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the Frame from which the dialog is displayed @param title the String to display in the dialog's title bar @param modal true for a modal dialog false for one that allows other windows to be active at the same time @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

Creates a modal or non-modal dialog without a title and with the specified owner Frame. If owner is null a shared hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale. @param owner the Frame from which the dialog is displayed @param modal true for a modal dialog false for one that allows others windows to be active at the same time @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @see JComponent#getDefaultLocale

By default children may not be added directly to a this component they must be added to its contentPane instead. For example:

 thisComponent.getContentPane().add(child) 

An attempt to add to directly to this component will cause an runtime exception to be thrown if rootPaneCheckingEnabled is true. Subclasses can disable this behavior. @param comp the Component to be enhanced @param constraints the constraints to be respected @param index the index (an integer) @see #setRootPaneCheckingEnabled @exception Error if called with rootPaneCheckingEnabled true

Processes key events occurring on this component andby dispatching them to any registered KeyListener objects.

This method is not called unless key events are enabled for this component. Key events are enabled when one of the following occurs:

• A KeyListener object is registered via addKeyListener.
• Key events are enabled via enableEvents.

Note that this method is not called by the event dispatch thread if appropriatethe component passes them on to components inis not the focus owner of if the dialogcomponent is not showing. This method is called when whichkey events haveare registered interestvia the addKeyListener or enableEvents methods but as of release 1.4 the implementation of the AWT event dispatching thread redirects KeyEvent to the focus owner. Please see the Focus Specification for further information.

If the event parameter is null the behavior is unspecified and may result in theman exception. @param e the key event @see java.awt.Componentevent.KeyEvent @see java.awt.event.KeyListener @see #addKeyListener @see #enableEvents @see #processKeyEventisShowing @since JDK1.1

By default the layout of this component may not be set the layout of its contentPane should be set instead. For example:

 thisComponent.getContentPane().setLayout(new BorderLayoutGridLayout(1 2)) 

An attempt to set the layout of this component will cause an runtime exception to be thrown if rootPaneCheckingEnabled is true. Subclasses can disable this behavior. @see #setRootPaneCheckingEnabled @param manager the LayoutManager @exception Error if called with rootPaneChecking true

Sets the location of the dialogwindow relative to the specified component. If the component is not currently showing or c is null the dialogwindow is centered on the screen. If the bottom of the component is offscreen the window is displayed to the right of the component. @param c the component in relation to which the dialogwindow's location is determined @since 1.4

Calls paint(g). This method was overridden to prevent an unneccessaryunnecessary call to clear the background. @param g the Graphics context in which to paint

A text component to edit various kinds of content. You can find how-to information and examples of using editor panes in Using Text Components a section in The Java Tutorial.

This component uses implementations of the EditorKit to accomplish its behavior. It effectively morphs into the proper kind of text editor for the kind of content it is given. The content type that editor is bound to at any given time is determined by the EditorKit currently installed. If the content is set to a new URL its type is used to determine the EditorKit that should be used to load the content.

By default the following types of content are known:

text/plain

Plain text which is the default the type given isn't recognized. The kit used in this case is an extension of DefaultEditorKit that produces a wrapped plain text view.

text/html

HTML text. The kit used in this case is the class javax.swing.text.html.HTMLEditorKit which provides HTML 3.2 support.

text/rtf

RTF text. The kit used in this case is the class javax.swing.text.rtf.RTFEditorKit which provides a limited support of the Rich Text Format.

There are several ways to load content into this component.

1. The setText method can be used to initialize the component from a string. In this case the current EditorKit will be used and the content type will be expected to be of this type.
2. The read method can be used to initialize the component from a Reader. Note that if the content type is HTML relative references (e.g. for things like images) can't be resolved unless the <base> tag is used or the Base property on HTMLDocument is set. In this case the current EditorKit will be used and the content type will be expected to be of this type.
3. The setPage method can be used to initialize the component from a URL. In this case the content type will be determined from the URL and the registered EditorKit for that content type will be set.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions see the JEditorPane key assignments.

Some kinds of content may provide hyperlink support by generating hyperlink events. The HTML EditorKit will generate hyperlink events if the JEditorPane is not editable (JEditorPane.setEditable(false); has been called). If HTML frames are embedded in the document the typical response would be to change a portion of the current document. The following code fragment is a possible hyperlink listener implementation that treats HTML frame events specially and simply displays any other activated hyperlinks.

   class Hyperactive implements HyperlinkListener {     public void hyperlinkUpdate(HyperlinkEvent e) {   if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {   JEditorPane pane = (JEditorPane) e.getSource();   if (e instanceof HTMLFrameHyperlinkEvent) {   HTMLFrameHyperlinkEvent evt = (HTMLFrameHyperlinkEvent)e;   HTMLDocument doc = (HTMLDocument)pane.getDocument();   doc.processHTMLFrameHyperlinkEvent(evt);   } else {   try {   pane.setPage(e.getURL());   } catch (Throwable t) {   t.printStackTrace();   }   }   }   }   } 

Culturally dependent information in some documents is handled through a mechanism called character encoding. Character encoding is an unambiguous mapping of the members of a character set (letters ideographs digits symbols or control functions) to specific numeric code values. It represents the way the file is stored. Example character encodings are ISO-8859-1 ISO-8859-5 Shift-jis Euc-jp and UTF-8. When the file is passed to an user agent (JEditorPane) it is converted to the document character set (ISO-10646 aka Unicode).

There are multiple ways to get a character set mapping to happen with JEditorPane.

1. One way is to specify the character set as a parameter of the MIME type. This will be established by a call to the setContentType method. If the content is loaded by the setPage method the content type will have been set according to the specification of the URL. It the file is loaded directly the content type would be expected to have been set prior to loading.
2. Another way the character set can be specified is in the document itself. This requires reading the document prior to determining the character set that is desired. To handle this it is expected that the EditorKit.read operation throw a ChangedCharSetException which will be caught. The read is then restarted with a new Reader that uses the character set specified in the ChangedCharSetException (which is an IOException).

Newlines

For a discussion on how newlines are handled see DefaultEditorKit.

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. A futureAs release of Swing will provide1.4 support for long term persistencestorage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder @beaninfo attribute: isContainer false description: A text component to edit various types of content. @author Timothy Prinzing @version 1.97 04113 12/0603/0001