StoresView

java.lang.Object
- org.eclipse.core.commands.common.EventManager
- - org.eclipse.ui.part.WorkbenchPart
  - - org.eclipse.ui.part.ViewPart
    - - com.ibm.commerce.telesales.ui.impl.views.stores.StoresView

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.action.IMenuListener, org.eclipse.ui.IPersistable, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.ISetSelectionTarget, org.eclipse.ui.part.IWorkbenchPartOrientation
```
public class StoresView
extends org.eclipse.ui.part.ViewPart
implements org.eclipse.jface.action.IMenuListener, org.eclipse.ui.ISelectionListener, org.eclipse.ui.part.ISetSelectionTarget
```
Main class for the IBM Sales Center Store View.
This standard view has ID "com.ibm.commerce.telesales.ui.storeview".

This view displays active stores within a tree widget. From the tree nodes, the user has access to different actions using context menus.

This view class may be sub-classed.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field
`static java.lang.String`	`CUSTOMER_EXT` Stores view menu: name of group for extra Customer-like actions (value `"customer.ext"`).
`static java.lang.String`	`FIND_EXT` Stores view menu: name of group for extra Find-like actions (value `"find.ext"`).
`static java.lang.String`	`ORDER_EXT` Stores view menu: name of group for extra Order-like actions (value `"order.ext"`).
`static java.lang.String`	`QUOTE_EXT` Stores view menu: name of group for extra Quote-like actions (value `"quote.ext"`).
`static java.lang.String`	`RETURNS_EXT` Stores view menu: name of group for extra Return-like actions (value `"returns.ext"`).
`static java.lang.String`	`STORE_EXT` Stores view menu: name of group for extra Store-like actions (value `"store.ext"`).
`static java.lang.String`	`STORES_VIEW_END` Stores view menu: name of group for end of menu (value `"storesViewEnd"`).
`static java.lang.String`	`STORES_VIEW_START` Stores view menu: name of group for start of menu (value `"storesViewStart"`).
`static java.lang.String`	`VIEW_ID` View ID (`com.ibm.commerce.telesales.storesView`).

Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE

Constructor Summary

Constructors
Constructor and Description

StoresView()
Constructor for StoreView.

Constructors
Constructor and Description
`StoresView()` Constructor for `StoreView`.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addViewerDoubleClickListeners()` Add Viewers Double click listener.
`protected void`	`addViewerSelectionChangedListeners()` Add Viewers selection changed listener.
`protected void`	`createActions()` Creates actions for this view.
`protected org.eclipse.jface.viewers.IContentProvider`	`createContentProvider()` Creates the content provider of this part.
`protected void`	`createContextMenu()` Creates the context menu for the viewers.
`protected org.eclipse.ui.actions.ActionGroup`	`createCustomerActionGroup()` Creates a new instance of `CustomerActionGroup`.
`protected org.eclipse.ui.actions.ActionGroup`	`createFindActionGroup()` Creates a new instance of `FindActionGroup`.
`protected org.eclipse.jface.viewers.ILabelProvider`	`createLabelProvider()` Creates the label provider of this part.
`protected org.eclipse.ui.actions.ActionGroup`	`createOrderActionGroup()` Creates a new instance of `OrderActionGroup`.
`void`	`createPartControl(org.eclipse.swt.widgets.Composite parent)` Creates the store list inner viewer.
`protected org.eclipse.ui.actions.ActionGroup`	`createQuoteActionGroup()` Creates a new instance of `QuoteActionGroup`.
`protected org.eclipse.ui.actions.ActionGroup`	`createReturnsActionGroup()` Creates a new instance of `QuoteActionGroup`.
`protected org.eclipse.ui.actions.ActionGroup`	`createSelectStoreLanguageActionGroup()` Creates a new instance of `SelectStoreLanguageActionGroup`.
`protected org.eclipse.ui.actions.ActionGroup`	`createStoreActionGroup()` Creates a new instance of `StoreActionGroup`.
`protected org.eclipse.jface.viewers.ViewerSorter`	`createStoreSorter()` Returns the structured viewer sorter.
`protected void`	`createToolbarButtons()` Creates the view actions toolbar buttons.
`protected org.eclipse.jface.viewers.StructuredViewer`	`createViewer(org.eclipse.swt.widgets.Composite parent)` Creates the viewer of this part.
`protected void`	`createViewPulldownMenu()` Creates the view actions pulldown menu.
`void`	`dispose()` Release resources by disposing this view.
`org.eclipse.swt.widgets.Display`	`getDisplay()` Returns the display to be used in this class, and in the actions.
`protected java.lang.String`	`getHelpContextId()` Retrieve the view's help context ID.
`java.lang.Object`	`getInitialInput()` Returns the viewer's initial input.
`org.eclipse.jface.viewers.ISelectionProvider`	`getSelectionProvider()` Returns the selection provider.
`org.eclipse.swt.widgets.Shell`	`getShell()` Returns the shell to use for opening dialogs.
`protected void`	`hookViewerListeners()` Adds additional listeners to this dialog.
`void`	`menuAboutToShow(org.eclipse.jface.action.IMenuManager menu)` Called when the context menu is about to open.
`void`	`selectionChanged(org.eclipse.ui.IWorkbenchPart part, org.eclipse.jface.viewers.ISelection selection)` Notifies this listener that the selection has changed.
`void`	`selectReveal(org.eclipse.jface.viewers.ISelection selection)` Reveals and selects the given element within this target view.
`void`	`setFocus()` Sets the initial focus when the view is presented.

Methods inherited from class org.eclipse.ui.part.ViewPart
checkSite, getViewSite, init, init, saveState, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field
    
    See Also:
    
    Constant Field Values
  - VIEW_ID
```
public static final java.lang.String VIEW_ID
```
    View ID (com.ibm.commerce.telesales.storesView).
    
    See Also:
    
    Constant Field Values
  - STORES_VIEW_START
```
public static final java.lang.String STORES_VIEW_START
```
    Stores view menu: name of group for start of menu (value "storesViewStart").
    
    See Also:
    
    Constant Field Values
  - STORES_VIEW_END
```
public static final java.lang.String STORES_VIEW_END
```
    Stores view menu: name of group for end of menu (value "storesViewEnd").
    
    See Also:
    
    Constant Field Values
  - STORE_EXT
```
public static final java.lang.String STORE_EXT
```
    Stores view menu: name of group for extra Store-like actions (value "store.ext").
    
    See Also:
    
    Constant Field Values
  - CUSTOMER_EXT
```
public static final java.lang.String CUSTOMER_EXT
```
    Stores view menu: name of group for extra Customer-like actions (value "customer.ext").
    
    See Also:
    
    Constant Field Values
  - ORDER_EXT
```
public static final java.lang.String ORDER_EXT
```
    Stores view menu: name of group for extra Order-like actions (value "order.ext").
    
    See Also:
    
    Constant Field Values
  - QUOTE_EXT
```
public static final java.lang.String QUOTE_EXT
```
    Stores view menu: name of group for extra Quote-like actions (value "quote.ext").
    
    See Also:
    
    Constant Field Values
  - RETURNS_EXT
```
public static final java.lang.String RETURNS_EXT
```
    Stores view menu: name of group for extra Return-like actions (value "returns.ext").
    
    See Also:
    
    Constant Field Values
  - FIND_EXT
```
public static final java.lang.String FIND_EXT
```
    Stores view menu: name of group for extra Find-like actions (value "find.ext").
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StoresView
```
public StoresView()
```
    Constructor for StoreView.
    Sets this view to be the starting view.
- Method Detail
  - setFocus
```
public void setFocus()
```
    Sets the initial focus when the view is presented.
    
    Specified by:
    
    setFocus in interface org.eclipse.ui.IWorkbenchPart
    
    Specified by:
    
    setFocus in class org.eclipse.ui.part.WorkbenchPart
    
    See Also:
    
    IWorkbenchPart.setFocus()
  - dispose
```
public void dispose()
```
    Release resources by disposing this view.
    
    Specified by:
    
    dispose in interface org.eclipse.ui.IWorkbenchPart
    
    Overrides:
    
    dispose in class org.eclipse.ui.part.WorkbenchPart
    
    See Also:
    
    IWorkbenchPart.dispose()
  - createPartControl
```
public void createPartControl(org.eclipse.swt.widgets.Composite parent)
```
    Creates the store list inner viewer.
    
    Specified by:
    
    createPartControl in interface org.eclipse.ui.IWorkbenchPart
    
    Specified by:
    
    createPartControl in class org.eclipse.ui.part.WorkbenchPart
    
    Parameters:
    
    parent - parent composite
    
    See Also:
    
    IWorkbenchPart.createPartControl(Composite)
  - getHelpContextId
```
protected java.lang.String getHelpContextId()
```
    Retrieve the view's help context ID. Value is ITelesalesHelpContextIds.STORES_VIEW.
    
    Returns:
    
    Help Context ID.
    
    See Also:
    
    ITelesalesHelpContextIds.STORES_VIEW
  - createViewer
```
protected org.eclipse.jface.viewers.StructuredViewer createViewer(org.eclipse.swt.widgets.Composite parent)
```
    Creates the viewer of this part.
    
    Parameters:
    
    parent - the parent for the viewer
    
    Returns:
    
    The structured viewer.
  - createStoreSorter
```
protected org.eclipse.jface.viewers.ViewerSorter createStoreSorter()
```
    Returns the structured viewer sorter. Returns an instance of StoresViewSorter.
    
    Returns:
    
    The sorter.
    
    See Also:
    
    StoresViewSorter
  - createContentProvider
```
protected org.eclipse.jface.viewers.IContentProvider createContentProvider()
```
    Creates the content provider of this part. Return an instance of StoresViewContentProvider.
    
    Returns:
    
    The contentProvider.
    
    See Also:
    
    StoresViewContentProvider
  - createLabelProvider
```
protected org.eclipse.jface.viewers.ILabelProvider createLabelProvider()
```
    Creates the label provider of this part. Return an instance of StoresViewLabelProvider.
    
    Returns:
    
    The labelProvider.
    
    See Also:
    
    StoresViewLabelProvider
  - createActions
```
protected void createActions()
```
    Creates actions for this view. The actions created are:
    - Order Action group
    - Quote Action group
    - Return Action group
    - Customer Action group
    - Store Action group
    - Find Action group
    See Also:
    
    createOrderActionGroup(), createQuoteActionGroup(), createReturnsActionGroup(), createCustomerActionGroup(), createStoreActionGroup(), createFindActionGroup()
  - createOrderActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createOrderActionGroup()
```
    Creates a new instance of OrderActionGroup.
    
    Returns:
    
    A new action group for the Order submenu.
    
    See Also:
    
    OrderActionGroup
  - createQuoteActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createQuoteActionGroup()
```
    Creates a new instance of QuoteActionGroup.
    
    Returns:
    
    A new action group for the quote actions.
    
    See Also:
    
    QuoteActionGroup
  - createReturnsActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createReturnsActionGroup()
```
    Creates a new instance of QuoteActionGroup.
    
    Returns:
    
    A new action group for the quote actions.
    
    See Also:
    
    ReturnsActionGroup
  - createCustomerActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createCustomerActionGroup()
```
    Creates a new instance of CustomerActionGroup.
    
    Returns:
    
    A new action group for the customer actions.
    
    See Also:
    
    CustomerActionGroup
  - createStoreActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createStoreActionGroup()
```
    Creates a new instance of StoreActionGroup.
    
    Returns:
    
    A new action group for the store actions.
    
    See Also:
    
    StoreActionGroup
  - createFindActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createFindActionGroup()
```
    Creates a new instance of FindActionGroup.
    
    Returns:
    
    A new action group for the find actions.
    
    See Also:
    
    FindActionGroup
  - createSelectStoreLanguageActionGroup
```
protected org.eclipse.ui.actions.ActionGroup createSelectStoreLanguageActionGroup()
```
    Creates a new instance of SelectStoreLanguageActionGroup.
    
    Returns:
    
    A new action group for the select store language submenu.
    
    See Also:
    
    SelectStoreLanguageActionGroup
  - createContextMenu
```
protected void createContextMenu()
```
    Creates the context menu for the viewers.
  - createToolbarButtons
```
protected void createToolbarButtons()
```
    Creates the view actions toolbar buttons.
  - createViewPulldownMenu
```
protected void createViewPulldownMenu()
```
    Creates the view actions pulldown menu.
  - hookViewerListeners
```
protected void hookViewerListeners()
```
    Adds additional listeners to this dialog. This method adds selection listeners and double click listeners.
    
    See Also:
    
    addViewerSelectionChangedListeners(), addViewerDoubleClickListeners()
  - addViewerSelectionChangedListeners
```
protected void addViewerSelectionChangedListeners()
```
    Add Viewers selection changed listener. This listener sets and resets the active object in the TelesalesModelManager.
    For example when a customer is selected in this view, TelesalesModelManager.getInstance().setActiveCustomer(customer) is invoked.
    
    See Also:
    
    ISelectionChangedListener
  - addViewerDoubleClickListeners
```
protected void addViewerDoubleClickListeners()
```
    Add Viewers Double click listener. This listener opens the corresponding editor when a user clicks on the object.
    
    See Also:
    
    IDoubleClickListener
  - getInitialInput
```
public java.lang.Object getInitialInput()
```
    Returns the viewer's initial input.
    
    Returns:
    
    The root node.
    
    See Also:
    
    TelesalesModelManager.getModelRoot()
  - getShell
```
public org.eclipse.swt.widgets.Shell getShell()
```
    Returns the shell to use for opening dialogs. Used in this class, and in the actions.
    
    Returns:
    
    The shell.
  - getDisplay
```
public org.eclipse.swt.widgets.Display getDisplay()
```
    Returns the display to be used in this class, and in the actions.
    
    Returns:
    
    The display.
  - getSelectionProvider
```
public org.eclipse.jface.viewers.ISelectionProvider getSelectionProvider()
```
    Returns the selection provider.
    
    Returns:
    
    The selection.
  - menuAboutToShow
```
public void menuAboutToShow(org.eclipse.jface.action.IMenuManager menu)
```
    Called when the context menu is about to open. Override to add your own context dependent menu contributions.
    
    Specified by:
    
    menuAboutToShow in interface org.eclipse.jface.action.IMenuListener
    
    Parameters:
    
    menu - the menu manager
  - selectionChanged
```
public void selectionChanged(org.eclipse.ui.IWorkbenchPart part,
                    org.eclipse.jface.viewers.ISelection selection)
```
    Notifies this listener that the selection has changed.
    
    Specified by:
    
    selectionChanged in interface org.eclipse.ui.ISelectionListener
    
    See Also:
    
    ISelectionListener.selectionChanged(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
  - selectReveal
```
public void selectReveal(org.eclipse.jface.viewers.ISelection selection)
```
    Reveals and selects the given element within this target view.
    
    Specified by:
    
    selectReveal in interface org.eclipse.ui.part.ISetSelectionTarget
    
    See Also:
    
    ISetSelectionTarget.selectReveal(org.eclipse.jface.viewers.ISelection)

Class StoresView

Field Summary

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.ui.part.ViewPart

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

Methods inherited from class org.eclipse.core.commands.common.EventManager

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

Field Detail

COPYRIGHT

VIEW_ID

STORES_VIEW_START

STORES_VIEW_END

STORE_EXT

CUSTOMER_EXT

ORDER_EXT

QUOTE_EXT

RETURNS_EXT

FIND_EXT

Constructor Detail

StoresView

Method Detail

setFocus

dispose

createPartControl

getHelpContextId

createViewer

createStoreSorter

createContentProvider

createLabelProvider

createActions

createOrderActionGroup

createQuoteActionGroup

createReturnsActionGroup

createCustomerActionGroup

createStoreActionGroup

createFindActionGroup

createSelectStoreLanguageActionGroup

createContextMenu

createToolbarButtons

createViewPulldownMenu

hookViewerListeners

addViewerSelectionChangedListeners

addViewerDoubleClickListeners

getInitialInput

getShell

getDisplay

getSelectionProvider

menuAboutToShow

selectionChanged

selectReveal