org.noos.xing.mydoggy.event.ToolWindowTabEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mydoggy-api

MyDoggy-Api contains the application program interface of MyDoggy to manage every aspects of the framework.

There is a newer version: 1.6.0

package org.noos.xing.mydoggy.event;

import org.noos.xing.mydoggy.ToolWindow;
import org.noos.xing.mydoggy.ToolWindowTab;

import java.util.EventObject;

/**
 * An event which indicates that an action occurred in a tool window with a tab as object.
 *
 * @author Angelo De Caro ([email protected])
 * @since 1.3.0
 */
public class ToolWindowTabEvent extends EventObject {

    public enum ActionId {
        TAB_ADDED,         // When a tab is added.
        TAB_REMOVED,       // When a tab is removed.
        TAB_REMOVING       // When a tab is removing.
    }

    /**
     * Indicates the action identifier.
     *
     * @see ActionId
     */
    private final ActionId actionId;

    /**
     * Indicates the tool window involved in the action. Cannot be null.
     */
    private final ToolWindow toolWindow;

    /**
     * Indicates the tab on which the action has occured. Cannot be null.
     */
    private final ToolWindowTab toolWindowTab;

    /**
     * Constructs a ToolWindowTabEvent object with the
     * specified source, actionId, tool window and tab.
     * 
     * This constructor throws an
     * IllegalArgumentException if the source or the actionId
     * or the toolWindow or the toolWindowTab is null.
     * 
     * @param source         the source where the action has occured.
     * @param actionId       the action identifier
     * @param toolWindow     the tool window on wicht the action is occurred.
     * @param toolWindowTab  the tab involved in the action.
     * @see ActionId
     * @see org.noos.xing.mydoggy.ToolWindow
     * @see org.noos.xing.mydoggy.ToolWindowTab
     */
    public ToolWindowTabEvent(Object source, ActionId actionId, ToolWindow toolWindow, ToolWindowTab toolWindowTab) {
        super(source);
        if (actionId == null)
            throw new IllegalArgumentException("null actionId");
        if (toolWindow == null)
            throw new IllegalArgumentException("null toolWindow");
        if (toolWindowTab == null)
            throw new IllegalArgumentException("null toolWindowTab");

        this.actionId = actionId;
        this.toolWindow = toolWindow;
        this.toolWindowTab = toolWindowTab;
    }

    /**
     * Returns the action identifier.
     *
     * @return the action identifier.
     */
    public ActionId getActionId() {
        return actionId;
    }

    /**
     * Returns the tool window involved in the action.
     *
     * @return the tool window.
     */
    public ToolWindow getToolWindow() {
        return toolWindow;
    }

    /**
     * Returns the tab involved in the action.
     *
     * @return the tool window.
     */
    public ToolWindowTab getToolWindowTab() {
        return toolWindowTab;
    }

    public String toString() {
        return "ToolWindowTabEvent{" +
               "actionId=" + actionId +
               ", toolWindow=" + toolWindow +
               ", toolWindowTab=" + toolWindowTab +
               '}';
    }
}