platform/lang-api/src/com/intellij/ide/hierarchy/HierarchyBrowser.java

/*
 * Copyright 2000-2009 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.hierarchy;

import com.intellij.ui.content.Content;

import javax.swing.*;

/**
 * Base class for components which can be displayed in the Hierarchy toolwindow.
 *
 * @author yole
 */
public interface HierarchyBrowser {
  /**
   * Returns the UI component to be displayed in the toolwindow.
   *
   * @return the component to show.
   */
  JComponent getComponent();

  /**
   * Notifies the browser that it's being displayed in the specified content.
   *
   * @param content the content in which the browser is displayed.
   */
  void setContent(final Content content);
}