javax.help.HelpAction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javahelp Show documentation
The JavaHelp API provides a platform-independent help framework.
The newest version!
/*
 * @(#)HelpAction.java	1.2 06/10/30
 * 
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 * 
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 * 
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package javax.help;

import java.beans.PropertyChangeListener;
/**
 * @author Stepan Marek
 * @version	1.2	10/30/06
 */
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);
    
}