/*
 * Copyright 2009 the original author or authors.
 *
 * 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 org.gradle.openapi.external.ui;

import java.awt.Component;

/**

 This represents a tab that the caller can add to the gradle UI.

  This is a mirror of GradleTab inside Gradle, but this is meant to aid
  backward and forward compatibility by shielding you from direct changes
  within gradle.

 @author mhunsicker
  */
public interface GradleTabVersion1
{
   /*
      @return the name of this tab
      @author mhunsicker
   */
   public String getName();

   /*
      This is where we should create your component.

      @return the component
      @author mhunsicker
   */
   public Component createComponent();

   /*
      Notification that this component is about to be shown. Do whatever
      initialization you choose. This is performed after serializing in your
      JDOMSerializables, so you can populate yourself now.
      @author mhunsicker
   */
   public void aboutToShow();
}
