View Javadoc

1   /*
2    *  XNap Commons
3    *
4    *  Copyright (C) 2005  Steffen Pingel
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or (at your option) any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.xnap.commons.gui.action;
21  
22  import javax.swing.Action;
23  
24  /***
25   * Defines the requirements for classes that support toggleable actions. This
26   * action class can be used for check box items.
27   */
28  public interface ToggleAction extends Action {
29  
30  	/***
31  	 * The key used for storing the selected state.
32  	 */
33  	public static final String SELECTED = "Selected";
34  	
35      /***
36       * Returns the selected state for the action.
37       */
38      boolean isSelected();
39  
40      /***
41       * Sets the selected state for the action.
42       */
43      void setSelected(boolean selected);
44  
45  }