javax.help.HelpAction Maven / Gradle / Ivy

/*
 * @(#) HelpAction.java 1.1 - last change made 10/19/01
 *
 * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
 *
 * This software is the confidential and proprietary information of Sun
 * Microsystems, Inc. ("Confidential Information").  You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Sun.
 *
 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
 * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
 * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
 * THIS SOFTWARE OR ITS DERIVATIVES.
 */

package javax.help;

import java.beans.PropertyChangeListener;
/**
 * @author Stepan Marek
 * @version	1.1	10/19/01
 */
public interface HelpAction {

    /** Getter for property enabled.
     * @return Value of property enabled.
     */
    public boolean isEnabled();
    
    /** Setter for property enabled.
     * @param enabled New value of property enabled.
     */
    public void setEnabled(boolean enabled);

    /** Getter for property control.
     * @return Value of property control.
     */
    public Object getControl();

    /**
     * Gets one of this object's properties
     * using the associated key.
     * @see #putValue
     */
    public Object getValue(String key);

    /**
     * Sets one of this object's properties
     * using the associated key. If the value has
     * changed, a PropertyChangeEvent is sent
     * to listeners.
     *
     * @param key    a String containing the key
     * @param value  an Object value
     */
    public void putValue(String key, Object value);
    
    /**
     * Adds a PropertyChange listener. Containers and attached
     * components use these methods to register interest in this 
     * Action object. When its enabled state or other property
     * changes, the registered listeners are informed of the change.
     *
     * @param listener  a PropertyChangeListener object
     */
    public void addPropertyChangeListener(PropertyChangeListener listener);
    
    /**
     * Removes a PropertyChange listener.
     *
     * @param listener  a PropertyChangeListener object
     * @see #addPropertyChangeListener
     */
    public void removePropertyChangeListener(PropertyChangeListener listener);
    
}