platform/structure-view-api/src/com/intellij/ide/util/treeView/smartTree/ActionPresentation.java

/*
 * Copyright 2000-2014 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.ide.util.treeView.smartTree;

import org.jetbrains.annotations.NotNull;

import javax.swing.*;

/**
 * The presentation information for a grouping, sorting or filtering action displayed in
 * a generic tree.
 *
 * @see TreeAction#getPresentation()
 * @see ActionPresentationData
 */

public interface ActionPresentation {
  /**
   * Returns the name of the action, displayed in the tooltip for the toolbar button.
   *
   * @return the action name.
   */
  @NotNull
  String getText();

  /**
   * Returns the description of the action, displayed in the status bar when the mouse
   * is over the toolbar button.
   *
   * @return the action description.
   */
  String getDescription();

  /**
   * Returns the icon for the action, displayed on the toolbar button.
   *
   * @return the action icon.
   */
  Icon getIcon();
}