com.cedarsoft.swing.action.Activatable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of actions Show documentation
There is a newer version: 8.1.1
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH 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 3 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
 * 3 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 cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.swing.action;


import javax.annotation.Nonnull;

import java.beans.PropertyChangeListener;
import java.lang.String;

/**
 * Interface for activatable classes.
 *
 * @author Johannes Schneider ([email protected])
 */
public interface Activatable {
  /**
   * Constant PROPERTY_ACTIVE="active"
   */
  @Nonnull
  String PROPERTY_ACTIVE = "active";

  /**
   * Whether the action is active
   *
   * @return whether the action is active
   */
  boolean isActive();

  /**
   * Adds a property change listener
   *
   * @param listener a {@link PropertyChangeListener} object.
   */
  void addPropertyChangeListener( @Nonnull PropertyChangeListener listener );

  /**
   * Removes a property change listener
   *
   * @param listener a {@link PropertyChangeListener} object.
   */
  void removePropertyChangeListener( @Nonnull PropertyChangeListener listener );

  /**
   * Adds a pcs listener
   *
   * @param propertyName a {@link String} object.
   * @param listener     a {@link PropertyChangeListener} object.
   */
  void addPropertyChangeListener( @Nonnull String propertyName, @Nonnull PropertyChangeListener listener );

  /**
   * remove the pcs listener
   *
   * @param propertyName a {@link String} object.
   * @param listener     a {@link PropertyChangeListener} object.
   */
  void removePropertyChangeListener( @Nonnull String propertyName, @Nonnull PropertyChangeListener listener );
}