< prev index next >
src/java.desktop/share/classes/javax/swing/colorchooser/AbstractColorChooserPanel.java
Print this page
*** 30,49 ****
import java.beans.PropertyChangeListener;
import javax.swing.*;
/**
* This is the abstract superclass for color choosers. If you want to add
! * a new color chooser panel into a <code>JColorChooser</code>, subclass
* this class.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
* future Swing releases. The current serialization support is
* appropriate for short term storage or RMI between applications running
* the same version of Swing. As of 1.4, support for long term storage
* of all JavaBeans™
! * has been added to the <code>java.beans</code> package.
* Please see {@link java.beans.XMLEncoder}.
*
* @author Tom Santos
* @author Steve Wilson
*/
--- 30,49 ----
import java.beans.PropertyChangeListener;
import javax.swing.*;
/**
* This is the abstract superclass for color choosers. If you want to add
! * a new color chooser panel into a {@code JColorChooser}, subclass
* this class.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
* future Swing releases. The current serialization support is
* appropriate for short term storage or RMI between applications running
* the same version of Swing. As of 1.4, support for long term storage
* of all JavaBeans™
! * has been added to the {@code java.beans} package.
* Please see {@link java.beans.XMLEncoder}.
*
* @author Tom Santos
* @author Steve Wilson
*/
*** 72,84 ****
*/
private JColorChooser chooser;
/**
* Invoked automatically when the model's state changes.
! * It is also called by <code>installChooserPanel</code> to allow
* you to set up the initial state of your chooser.
! * Override this method to update your <code>ChooserPanel</code>.
*/
public abstract void updateChooser();
/**
* Builds a new chooser panel.
--- 72,84 ----
*/
private JColorChooser chooser;
/**
* Invoked automatically when the model's state changes.
! * It is also called by {@code installChooserPanel} to allow
* you to set up the initial state of your chooser.
! * Override this method to update your {@code ChooserPanel}.
*/
public abstract void updateChooser();
/**
* Builds a new chooser panel.
*** 91,108 ****
*/
public abstract String getDisplayName();
/**
* Provides a hint to the look and feel as to the
! * <code>KeyEvent.VK</code> constant that can be used as a mnemonic to
* access the panel. A return value <= 0 indicates there is no mnemonic.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way.
* <p>
* This implementation returns 0, indicating the
! * <code>AbstractColorChooserPanel</code> does not support a mnemonic,
* subclasses wishing a mnemonic will need to override this.
*
* @return KeyEvent.VK constant identifying the mnemonic; <= 0 for no
* mnemonic
* @see #getDisplayedMnemonicIndex
--- 91,108 ----
*/
public abstract String getDisplayName();
/**
* Provides a hint to the look and feel as to the
! * {@code KeyEvent.VK} constant that can be used as a mnemonic to
* access the panel. A return value <= 0 indicates there is no mnemonic.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way.
* <p>
* This implementation returns 0, indicating the
! * {@code AbstractColorChooserPanel} does not support a mnemonic,
* subclasses wishing a mnemonic will need to override this.
*
* @return KeyEvent.VK constant identifying the mnemonic; <= 0 for no
* mnemonic
* @see #getDisplayedMnemonicIndex
*** 112,134 ****
return 0;
}
/**
* Provides a hint to the look and feel as to the index of the character in
! * <code>getDisplayName</code> that should be visually identified as the
* mnemonic. The look and feel should only use this if
! * <code>getMnemonic</code> returns a value > 0.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way. For example,
* a look and feel may wish to render each
! * <code>AbstractColorChooserPanel</code> in a <code>JTabbedPane</code>,
* and further use this return value to underline a character in
! * the <code>getDisplayName</code>.
* <p>
* This implementation returns -1, indicating the
! * <code>AbstractColorChooserPanel</code> does not support a mnemonic,
* subclasses wishing a mnemonic will need to override this.
*
* @return Character index to render mnemonic for; -1 to provide no
* visual identifier for this panel.
* @see #getMnemonic
--- 112,134 ----
return 0;
}
/**
* Provides a hint to the look and feel as to the index of the character in
! * {@code getDisplayName} that should be visually identified as the
* mnemonic. The look and feel should only use this if
! * {@code getMnemonic} returns a value > 0.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way. For example,
* a look and feel may wish to render each
! * {@code AbstractColorChooserPanel} in a {@code JTabbedPane},
* and further use this return value to underline a character in
! * the {@code getDisplayName}.
* <p>
* This implementation returns -1, indicating the
! * {@code AbstractColorChooserPanel} does not support a mnemonic,
* subclasses wishing a mnemonic will need to override this.
*
* @return Character index to render mnemonic for; -1 to provide no
* visual identifier for this panel.
* @see #getMnemonic
*** 150,160 ****
*/
public abstract Icon getLargeDisplayIcon();
/**
* Invoked when the panel is added to the chooser.
! * If you override this, be sure to call <code>super</code>.
*
* @param enclosingChooser the chooser to which the panel is to be added
* @exception RuntimeException if the chooser panel has already been
* installed
*/
--- 150,160 ----
*/
public abstract Icon getLargeDisplayIcon();
/**
* Invoked when the panel is added to the chooser.
! * If you override this, be sure to call {@code super}.
*
* @param enclosingChooser the chooser to which the panel is to be added
* @exception RuntimeException if the chooser panel has already been
* installed
*/
*** 169,201 ****
updateChooser();
}
/**
* Invoked when the panel is removed from the chooser.
! * If override this, be sure to call <code>super</code>.
*
* @param enclosingChooser the chooser from which the panel is to be removed
*/
public void uninstallChooserPanel(JColorChooser enclosingChooser) {
chooser.removePropertyChangeListener("enabled", enabledListener);
chooser = null;
}
/**
* Returns the model that the chooser panel is editing.
! * @return the <code>ColorSelectionModel</code> model this panel
* is editing
*/
public ColorSelectionModel getColorSelectionModel() {
return (this.chooser != null)
? this.chooser.getSelectionModel()
: null;
}
/**
* Returns the color that is currently selected.
! * @return the <code>Color</code> that is selected
*/
protected Color getColorFromModel() {
ColorSelectionModel model = getColorSelectionModel();
return (model != null)
? model.getSelectedColor()
--- 169,201 ----
updateChooser();
}
/**
* Invoked when the panel is removed from the chooser.
! * If override this, be sure to call {@code super}.
*
* @param enclosingChooser the chooser from which the panel is to be removed
*/
public void uninstallChooserPanel(JColorChooser enclosingChooser) {
chooser.removePropertyChangeListener("enabled", enabledListener);
chooser = null;
}
/**
* Returns the model that the chooser panel is editing.
! * @return the {@code ColorSelectionModel} model this panel
* is editing
*/
public ColorSelectionModel getColorSelectionModel() {
return (this.chooser != null)
? this.chooser.getSelectionModel()
: null;
}
/**
* Returns the color that is currently selected.
! * @return the {@code Color} that is selected
*/
protected Color getColorFromModel() {
ColorSelectionModel model = getColorSelectionModel();
return (model != null)
? model.getSelectedColor()
*** 243,265 ****
return true;
}
/**
* Draws the panel.
! * @param g the <code>Graphics</code> object
*/
public void paint(Graphics g) {
super.paint(g);
}
/**
! * Returns an integer from the defaults table. If <code>key</code> does
! * not map to a valid <code>Integer</code>, <code>default</code> is
* returned.
*
! * @param key an <code>Object</code> specifying the int
! * @param defaultValue Returned value if <code>key</code> is not available,
* or is not an Integer
* @return the int
*/
int getInt(Object key, int defaultValue) {
Object value = UIManager.get(key, getLocale());
--- 243,265 ----
return true;
}
/**
* Draws the panel.
! * @param g the {@code Graphics} object
*/
public void paint(Graphics g) {
super.paint(g);
}
/**
! * Returns an integer from the defaults table. If {@code key} does
! * not map to a valid {@code Integer}, {@code default} is
* returned.
*
! * @param key an {@code Object} specifying the int
! * @param defaultValue Returned value if {@code key} is not available,
* or is not an Integer
* @return the int
*/
int getInt(Object key, int defaultValue) {
Object value = UIManager.get(key, getLocale());
< prev index next >