← Back to branch summary

~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to ext/src/javahelp/jhMaster/JavaHelp/src/new/javax/help/HelpAction.java

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ext/src/javahelp/jhMaster/JavaHelp/src/new/javax/help/HelpAction.java
 
1
/*
 
2
 * @(#)HelpAction.java  1.2 06/10/30
 
3
 * 
 
4
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 
5
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 
6
 * 
 
7
 * This code is free software; you can redistribute it and/or modify it
 
8
 * under the terms of the GNU General Public License version 2 only, as
 
9
 * published by the Free Software Foundation.  Sun designates this
 
10
 * particular file as subject to the "Classpath" exception as provided
 
11
 * by Sun in the LICENSE file that accompanied this code.
 
12
 * 
 
13
 * This code is distributed in the hope that it will be useful, but WITHOUT
 
14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
15
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 
16
 * version 2 for more details (a copy is included in the LICENSE file that
 
17
 * accompanied this code).
 
18
 * 
 
19
 * You should have received a copy of the GNU General Public License version
 
20
 * 2 along with this work; if not, write to the Free Software Foundation,
 
21
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
22
 * 
 
23
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 
24
 * CA 95054 USA or visit www.sun.com if you need additional information or
 
25
 * have any questions.
 
26
 */
 
27
 
 
28
package javax.help;
 
29
 
 
30
import java.beans.PropertyChangeListener;
 
31
/**
 
32
 * @author Stepan Marek
 
33
 * @version     1.2     10/30/06
 
34
 */
 
35
public interface HelpAction {
 
36
 
 
37
    /** Getter for property enabled.
 
38
     * @return Value of property enabled.
 
39
     */
 
40
    public boolean isEnabled();
 
41
    
 
42
    /** Setter for property enabled.
 
43
     * @param enabled New value of property enabled.
 
44
     */
 
45
    public void setEnabled(boolean enabled);
 
46
 
 
47
    /** Getter for property control.
 
48
     * @return Value of property control.
 
49
     */
 
50
    public Object getControl();
 
51
 
 
52
    /**
 
53
     * Gets one of this object's properties
 
54
     * using the associated key.
 
55
     * @see #putValue
 
56
     */
 
57
    public Object getValue(String key);
 
58
 
 
59
    /**
 
60
     * Sets one of this object's properties
 
61
     * using the associated key. If the value has
 
62
     * changed, a <code>PropertyChangeEvent</code> is sent
 
63
     * to listeners.
 
64
     *
 
65
     * @param key    a <code>String</code> containing the key
 
66
     * @param value  an <code>Object</code> value
 
67
     */
 
68
    public void putValue(String key, Object value);
 
69
    
 
70
    /**
 
71
     * Adds a <code>PropertyChange</code> listener. Containers and attached
 
72
     * components use these methods to register interest in this 
 
73
     * <code>Action</code> object. When its enabled state or other property
 
74
     * changes, the registered listeners are informed of the change.
 
75
     *
 
76
     * @param listener  a <code>PropertyChangeListener</code> object
 
77
     */
 
78
    public void addPropertyChangeListener(PropertyChangeListener listener);
 
79
    
 
80
    /**
 
81
     * Removes a <code>PropertyChange</code> listener.
 
82
     *
 
83
     * @param listener  a <code>PropertyChangeListener</code> object
 
84
     * @see #addPropertyChangeListener
 
85
     */
 
86
    public void removePropertyChangeListener(PropertyChangeListener listener);
 
87
    
 
88
}
 
89