Modelers

org.topcased.search.ui.pages
Class ModelExtensibleSearchPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.topcased.search.ui.pages.ModelExtensibleSearchPage
All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.search.ui.ISearchPage

public final class ModelExtensibleSearchPage
extends org.eclipse.jface.dialogs.DialogPage
implements org.eclipse.search.ui.ISearchPage

Defines a page contributed to the org.eclipse.search.searchPages extension point.

This pages exposes three different areas :

  • query area
  • participant area
  • scope area


    Query Area

    The query area displays a TabFolder containing a tab for every query contributed to modelSearchQueryTab the extension point.


    Participant Area

    The participant area displays a TabFolder containing a tab for every query contributed to modelSearchParticipantTab the extension point.


    Scope Area

    The Scope area displays a group containing possibles workspace search scopes.



    Field Summary
     
    Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
    ERROR, INFORMATION, NONE, WARNING
     
    Constructor Summary
    ModelExtensibleSearchPage()
               
     
    Method Summary
     void createControl(org.eclipse.swt.widgets.Composite parent)
               
    protected  void createParticipantTabsArea(org.eclipse.swt.widgets.Composite parent)
               
    protected  void createSearchQueryArea(org.eclipse.swt.widgets.Composite parent)
               
     org.eclipse.search.ui.ISearchPageContainer getContainer()
              Return Page Container for the current model search page.
     ParticipantTabDescriptor getCurrentlySelectedParticipantDescriptor()
              Returns current particpant configuration coming from participant area controls settings
     org.eclipse.swt.widgets.TabItem getCurrentlySelectedParticipantTabItem()
              Returns current particpant tab item coming from participant area controls settings
     QueryTabDescriptor getCurrentlySelectedQueryDescriptor()
              Returns current particpant configuration coming from query area controls settings
     org.eclipse.swt.widgets.TabItem getCurrentlySelectedQueryTabItem()
              Returns current particpant tab item coming from query area controls settings
     ModelSearchEngineDescriptor getSearchEngineDescriptorFromPageSelection(QueryTabDescriptor q, ParticipantTabDescriptor p)
              Returns search engine associated with given (query, particpant) tabs selection.
     boolean performAction()
              Called whenever user clicks on the search button
     void setContainer(org.eclipse.search.ui.ISearchPageContainer c)
              Sets the search page's container.
     
    Methods inherited from class org.eclipse.jface.dialogs.DialogPage
    convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setDescription, setErrorMessage, setImageDescriptor, setMessage, setMessage, setTitle, setVisible
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     
    Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
    dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
     

    Constructor Detail

    ModelExtensibleSearchPage

    public ModelExtensibleSearchPage()
    Method Detail

    createSearchQueryArea

    protected void createSearchQueryArea(org.eclipse.swt.widgets.Composite parent)

    createParticipantTabsArea

    protected void createParticipantTabsArea(org.eclipse.swt.widgets.Composite parent)

    createControl

    public void createControl(org.eclipse.swt.widgets.Composite parent)
    Specified by:
    createControl in interface org.eclipse.jface.dialogs.IDialogPage

    performAction

    public boolean performAction()
    Called whenever user clicks on the search button

    Specified by:
    performAction in interface org.eclipse.search.ui.ISearchPage

    getCurrentlySelectedParticipantDescriptor

    public ParticipantTabDescriptor getCurrentlySelectedParticipantDescriptor()
    Returns current particpant configuration coming from participant area controls settings


    getCurrentlySelectedQueryDescriptor

    public QueryTabDescriptor getCurrentlySelectedQueryDescriptor()
    Returns current particpant configuration coming from query area controls settings


    getCurrentlySelectedParticipantTabItem

    public org.eclipse.swt.widgets.TabItem getCurrentlySelectedParticipantTabItem()
    Returns current particpant tab item coming from participant area controls settings


    getCurrentlySelectedQueryTabItem

    public org.eclipse.swt.widgets.TabItem getCurrentlySelectedQueryTabItem()
    Returns current particpant tab item coming from query area controls settings


    getSearchEngineDescriptorFromPageSelection

    public ModelSearchEngineDescriptor getSearchEngineDescriptorFromPageSelection(QueryTabDescriptor q,
                                                                                  ParticipantTabDescriptor p)
    Returns search engine associated with given (query, particpant) tabs selection.


    setContainer

    public void setContainer(org.eclipse.search.ui.ISearchPageContainer c)
    Sets the search page's container.

    Specified by:
    setContainer in interface org.eclipse.search.ui.ISearchPage
    Parameters:
    searchPageContainer - the container to set

    getContainer

    public org.eclipse.search.ui.ISearchPageContainer getContainer()
    Return Page Container for the current model search page.

    Returns:
    The current model search page Page Container, null otherwise.

    Modelers

    Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.