KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > search > ui > ISearchPage


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.search.ui;
12
13 import org.eclipse.jface.dialogs.IDialogPage;
14
15 /**
16  * Interface to be implemented by contributors to the extension point <code>org.eclipse.search.searchPages</code>.
17  * Represents a page in the search dialog. Implemented typically subclass <code>DialogPage</code>.
18  * <p>
19  * The search dialog calls the <code>performAction</code> method when the Search
20  * button is pressed.
21  * <p>
22  *
23  * @see org.eclipse.jface.dialogs.IDialogPage
24  * @see org.eclipse.jface.dialogs.DialogPage
25  */
26 public interface ISearchPage extends IDialogPage {
27
28     /**
29      * Performs the action for this page.
30      * The search dialog calls this method when the Search
31      * button is pressed.
32      *
33      * @return <code>true</code> if the dialog can be closed after execution
34      */
35     public boolean performAction();
36
37     /**
38      * Sets the container of this page.
39      * The search dialog calls this method to initialize this page.
40      * Implementations may store the reference to the container.
41      *
42      * @param container the container for this page
43      */
44     public void setContainer(ISearchPageContainer container);
45 }
46
Popular Tags