Java JTextComponent getStoredBackground(JTextComponent comp)

Description

Returns the background color that has been previously stored for the given component, or null if none.

License

Open Source License

Parameter

Parameter	Description
comp	the component to be requested

Return

the background color that has been previously stored for the given component, or null if none.

Declaration

private static Color getStoredBackground(JTextComponent comp)

Method Source Code


//package com.java2s;
import java.awt.Color;

import javax.swing.text.JTextComponent;

public class Main {
    /**/*from w w  w .j av a  2  s.co  m*/
     * The JComponent client property key used to store a component's 
     * original background color. The stored background can be restored later.
     * 
     * @see #getStoredBackground(JTextComponent)
     * @see #restoreBackground(JTextComponent)
     * @see #ensureCustomBackgroundStored(JTextComponent)
     * @see #setMandatoryBackground(JTextComponent)
     */
    private static final String STORED_BACKGROUND_KEY = "validation.storedBackground";

    /**
     * Returns the background color that has been previously stored for
     * the given component, or <code>null</code> if none.
     * 
     * @param comp  the component to be requested 
     * @return the background color that has been previously stored for
     *     the given component, or <code>null</code> if none.
     * 
     * @see #ensureCustomBackgroundStored(JTextComponent)
     * @see #restoreBackground(JTextComponent)
     */
    private static Color getStoredBackground(JTextComponent comp) {
        return (Color) comp.getClientProperty(STORED_BACKGROUND_KEY);
    }
}