/*
 * Copyright (C) 2004 NNL Technology AB
 * Visit www.infonode.net for information about InfoNode(R) 
 * products and how to contact NNL Technology AB.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, 
 * MA 02111-1307, USA.
 */


// $Id: TabbedUtils.java,v 1.10 2005/02/16 11:28:15 jesper Exp $
package api.infonode.tabbedpanel;

import api.infonode.gui.hover.hoverable.HoverManager;

import java.awt.*;

/**
 * Utility methods
 *
 * @author $Author: jesper $
 * @version $Revision: 1.10 $
 */
public class TabbedUtils {
  private TabbedUtils() {
  }

  /**
   * <p>Gets the tab for whom the given component is a child.</p>
   *
   * <p><strong>Note:</strong> This is not a method for retrieving the tab for a specific content
   * component. This method is only useful for finding the Tab for components that
   * have been added to a Tab.</p>
   *
   * @param c the component
   * @return the tab or null if component is not a child of any tab
   */
  public static Tab getParentTab(Component c) {
    while (c != null) {
      if (c instanceof Tab)
        return (Tab) c;
      c = c.getParent();
    }
    return null;
  }

  /**
   * Gets the tabbed panel for whom the given component is a child
   *
   * @param c the component
   * @return the tabbed panel or null if component is not a child of any tabbed panel
   */
  public static TabbedPanel getParentTabbedPanel(Component c) {
    while (c != null) {
      if (c instanceof TabbedPanel)
        return (TabbedPanel) c;
      c = c.getParent();
    }

    return null;
  }

  /**
   * Gets the TabbedPanelContentPanel for whom the given component is a child
   *
   * @param c the component
   * @return the content panel or null if component is not a child of any
   *         tabbed panel content panel
   */
  public static TabbedPanelContentPanel getParentTabbedPanelContentPanel(Component c) {
    while (c != null) {
      if (c instanceof TabbedPanelContentPanel)
        return (TabbedPanelContentPanel) c;

      c = c.getParent();
    }

    return null;
  }

  /**
   * <p>
   * Checks to see if hover is enabled i.e. if the AWTPermission "listenToAllAWTEvents" has been
   * granted so that hover can be used.
   * </p>
   *
   * <p>
   * Note: This method is not meant to be used for permission checks, only as a convenience to
   * check if hover is enabled or not.
   * </p>
   *
   * @return true if hover is enabled, otherwise false
   * @since ITP 1.3.0
   */
  public static boolean isHoverEnabled() {
    return HoverManager.getInstance().isEventListeningActive();
  }
}
