**   Copyright notice                                                       **

**                                                                          **

**   (c) 2005-2006 RSSOwl Development Team                                  **

**   http://www.rssowl.org/                                                 **

**                                                                          **

**   All rights reserved                                                    **

**                                                                          **

**   This program and the accompanying materials are made available under   **

**   the terms of the Eclipse Public License v1.0 which accompanies this    **

**   distribution, and is available at:                                     **

**   http://www.rssowl.org/legal/epl-v10.html                               **

**                                                                          **

**   A copy is found in the file epl-v10.html and important notices to the  **

**   license from the team is found in the textfile LICENSE.txt distributed **

**   in this package.                                                       **

**                                                                          **

**   This copyright notice MUST APPEAR in all copies of the file!           **

**                                                                          **

**   Contributors:                                                          **

**     RSSOwl Development Team - initial API and implementation             **

**                                                                          **

**  **********************************************************************  */

* The FeedView is an instance of <code>EditorPart</code> capable of

* displaying News in a Table-Viewer and Browser-Viewer. It offers controls to

* Filter and Group them.

* <p>

* TODO Think about storing settings in a central place in memory and flush them

* to the DB on shutdown. Alternative: Update settings while action is invoked

* with a short delay (in non-UI-Thread).

* </p>

*

* @author bpasero

*/

  /* Cache to remember selected News-Items */

  private static Map<Integer, NewsReference> fgSelectionCache = new HashMap<Integer, NewsReference>();

  /* TODO Move this to Settings */

  private static final boolean BROWSER_SHOWS_ALL = false;

  /* Delay in ms to Mark *new* News to *unread* on Part-Deactivation */

  private static final int HANDLE_NEWS_SEEN_DELAY = 100;

  /** ID of this EditorPart */

  public static final String ID = "org.rssowl.ui.FeedView"; //$NON-NLS-1$

  /** List of UI-Events interesting for the FeedView */

  public enum UIEvent {

    /** Other Feed Displayed */

    FEED_CHANGE,

    /** Application Minimized */

    MINIMIZE,

    /** Application Closing */

    CLOSE

  }

  /* Editor Data */

  private FeedViewInput fInput;

  private IEditorSite fEditorSite;

  /* Part to display News in Table */

  private NewsTableControl fNewsTableControl;

  /* Part to display News in Browser */

  private NewsBrowserControl fNewsBrowserControl;

  /* Bars */

  private FilterBar fFilterBar;

  private BrowserBar fBrowserBar;

  /* Shared Viewer classes */

  private NewsFilter fNewsFilter;

  private NewsGrouping fNewsGrouping;

  private NewsContentProvider fContentProvider;

  /* Container for the Browser Viewer */

  private Composite fBrowserViewerControlContainer;

  /* Listeners */

  private IPartListener2 fPartListener;

  private BookMarkListener fBookMarkListener;

  private SearchMarkAdapter fSearchMarkListener;

  private FeedAdapter fFeedListener;

  private SearchConditionListener fSearchConditionListener;

  /* Settings */

  NewsFilter.Type fInitialFilterType;

  NewsGrouping.Type fInitialGroupType;

  NewsFilter.SearchTarget fInitialSearchTarget;

  boolean fInitialLayoutVertical;

  private boolean fInitialBrowserMaximized;

  private int fInitialWeights[];

  private int fCacheWeights[];

  /* Global Actions */

  private IAction fReloadAction;

  private IAction fSelectAllAction;

  private IAction fDeleteAction;

  private IAction fCutAction;

  private IAction fCopyAction;

  private IAction fPasteAction;

  private IAction fMarkAllReadAction;

  private IAction fFindAction;

  private IAction fPrintAction;

  /* Misc. */

  private Composite fParent;

  private SashForm fSashForm;

  private Label fTableBrowserSep;

  private LocalResourceManager fResourceManager;

  private IPreferenceScope fPreferences;

  private long fOpenTime;

  private boolean fCreated;

  private Object fCacheJobIdentifier = new Object();

  private ImageDescriptor fTitleImageDescriptor;

  private NewsService fNewsService;

  private Label fBrowserSep;

  /*

   * @see org.eclipse.ui.part.EditorPart#doSave(org.eclipse.core.runtime.IProgressMonitor)

   */

  @Override

  public void doSave(IProgressMonitor monitor) {

  /* Not Supported */

  }

  /*

   * @see org.eclipse.ui.part.EditorPart#doSaveAs()

   */

  @Override

  public void doSaveAs() {

  /* Not Supported */

  }

  /*

   * @see org.eclipse.ui.part.EditorPart#init(org.eclipse.ui.IEditorSite,

   * org.eclipse.ui.IEditorInput)

   */

  @Override

  public void init(IEditorSite site, IEditorInput input) {

    Assert.isTrue(input instanceof FeedViewInput);

    fEditorSite = site;

    setSite(site);

    fResourceManager = new LocalResourceManager(JFaceResources.getResources());

    fNewsService = Controller.getDefault().getNewsService();

    /* Load Settings */

    fPreferences = Owl.getPreferenceService().getGlobalScope();

    loadSettings((FeedViewInput) input);

    /* Apply Input */

    setInput(input);

    /* Hook into Global Actions */

    createGlobalActions();

    setGlobalActions();

    /* Register Listeners */

    registerListeners();

  }

  private void registerListeners() {

    fPartListener = new IPartListener2() {

      /* Mark *new* News as *unread* ot *read* */

      public void partHidden(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false)) && fInput.getMark() instanceof IBookMark)

          if (System.currentTimeMillis() - fOpenTime > HANDLE_NEWS_SEEN_DELAY)

            notifyUIEvent(UIEvent.FEED_CHANGE);

      }

      /* Hook into Global Actions for this Editor */

      public void partBroughtToTop(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false))) {

          setGlobalActions();

          OwlUI.updateWindowTitle(fInput != null ? new IMark[] { fInput.getMark() } : null);

        }

      }

      public void partClosed(IWorkbenchPartReference partRef) {

        IEditorReference[] editors = partRef.getPage().getEditorReferences();

        if (editors.length == 0 && FeedView.this.equals(partRef.getPart(false)))

          OwlUI.updateWindowTitle(null);

      }

      public void partDeactivated(IWorkbenchPartReference partRef) {}

      public void partActivated(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false)))

          OwlUI.updateWindowTitle(fInput != null ? new IMark[] { fInput.getMark() } : null);

      }

      public void partInputChanged(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false)))

          OwlUI.updateWindowTitle(fInput != null ? new IMark[] { fInput.getMark() } : null);

      }

      public void partOpened(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false))) {

          fOpenTime = System.currentTimeMillis();

          OwlUI.updateWindowTitle(fInput != null ? new IMark[] { fInput.getMark() } : null);

        }

      }

      public void partVisible(IWorkbenchPartReference partRef) {

        if (FeedView.this.equals(partRef.getPart(false)))

          OwlUI.updateWindowTitle(fInput != null ? new IMark[] { fInput.getMark() } : null);

      }

    };

    fEditorSite.getPage().addPartListener(fPartListener);

    /* Close Editor if Input was Deleted (BookMark) */

    fBookMarkListener = new BookMarkAdapter() {

      @Override

      public void entitiesDeleted(Set<BookMarkEvent> events) {

        for (BookMarkEvent event : events) {

          IBookMark mark = event.getEntity();

          if (mark.getId().equals(fInput.getMark().getId())) {

            fInput.setDeleted();

            fEditorSite.getPage().closeEditor(FeedView.this, false);

            break;

          }

        }

      }

      @Override

      public void entitiesUpdated(Set<BookMarkEvent> events) {

        for (BookMarkEvent event : events) {

          final IBookMark mark = event.getEntity();

          if (mark.getId().equals(fInput.getMark().getId())) {

            JobRunner.runInUIThread(fParent, new Runnable() {

              public void run() {

                setPartName(mark.getName());

                OwlUI.updateWindowTitle(new IMark[] { fInput.getMark() });

              }

            });

            break;

          }

        }

      }

    };

    DynamicDAO.addEntityListener(IBookMark.class, fBookMarkListener);

    /* Close Editor if Input was Deleted & Update on results Changed */

    fSearchMarkListener = new SearchMarkAdapter() {

      @Override

      public void entitiesDeleted(Set<SearchMarkEvent> events) {

        for (SearchMarkEvent event : events) {

          ISearchMark mark = event.getEntity();

          if (fInput.getMark().getId().equals(mark.getId())) {

            fEditorSite.getPage().closeEditor(FeedView.this, false);

            fInput.setDeleted();

            break;

          }

        }

      }

      @Override

      public void entitiesUpdated(Set<SearchMarkEvent> events) {

        for (SearchMarkEvent event : events) {

          final ISearchMark mark = event.getEntity();

          if (mark.getId().equals(fInput.getMark().getId())) {

            JobRunner.runInUIThread(fParent, new Runnable() {

              public void run() {

                setPartName(mark.getName());

                OwlUI.updateWindowTitle(new IMark[] { fInput.getMark() });

              }

            });

            break;

          }

        }

      }

    };

    DynamicDAO.addEntityListener(ISearchMark.class, fSearchMarkListener);

    /* Refresh on Condition Changes if SearchMark showing */

    fSearchConditionListener = new SearchConditionListener() {

      public void entitiesAdded(Set<SearchConditionEvent> events) {

        refreshIfRequired(events);

      }

      public void entitiesDeleted(Set<SearchConditionEvent> events) {

        refreshIfRequired(events);

      }

      public void entitiesUpdated(Set<SearchConditionEvent> events) {

        refreshIfRequired(events);

      }

      private void refreshIfRequired(Set<SearchConditionEvent> events) {

        ISearchMarkDAO dao = DynamicDAO.getDAO(ISearchMarkDAO.class);

        for (SearchConditionEvent event : events) {

          ISearchCondition condition = event.getEntity();

          ISearchMark searchMark = dao.load(condition);

          if (searchMark != null && searchMark.equals(fInput.getMark())) {

            JobRunner.runUIUpdater(new UIBackgroundJob(fParent) {

              @Override

              protected void runInBackground(IProgressMonitor monitor) {

                fContentProvider.refreshCache(new IMark[] { fInput.getMark() }, false);

              }

              @Override

              protected void runInUI(IProgressMonitor monitor) {

                refresh(true, true);

              }

              @Override

              public boolean belongsTo(Object family) {

                return fCacheJobIdentifier.equals(family);

              }

            });

            break;

          }

        }

      }

    };

    DynamicDAO.addEntityListener(ISearchCondition.class, fSearchConditionListener);

    /* Listen if Title Image is changing */

    fFeedListener = new FeedAdapter() {

      @Override

      public void entitiesUpdated(Set<FeedEvent> events) {

        /* Not supported for Searchmarks */

        if (fInput.getMark() instanceof ISearchMark || events.size() == 0)

          return;

        /* Check if Feed-Event affecting us */

        for (FeedEvent event : events) {

          FeedLinkReference feedRef = ((IBookMark) fInput.getMark()).getFeedLinkReference();

          if (feedRef.references(event.getEntity())) {

            ImageDescriptor imageDesc = fInput.getImageDescriptor();

            /* Title Image Change - Update! */

            if (!fTitleImageDescriptor.equals(imageDesc)) {

              fTitleImageDescriptor = imageDesc;

              JobRunner.runInUIThread(fParent, new Runnable() {

                public void run() {

                  setTitleImage(OwlUI.getImage(fResourceManager, fTitleImageDescriptor));

                }

              });

            }

            break;

          }

        }

      }

    };

    DynamicDAO.addEntityListener(IFeed.class, fFeedListener);

  }

  private void loadSettings(FeedViewInput input) {

    /* Filter Settings */

    IPreferenceScope preferences = Owl.getPreferenceService().getEntityScope(input.getMark());

    int iVal = preferences.getInteger(DefaultPreferences.BM_NEWS_FILTERING);

    if (iVal >= 0)

      fInitialFilterType = NewsFilter.Type.values()[iVal];

    else

      fInitialFilterType = NewsFilter.Type.values()[fPreferences.getInteger(DefaultPreferences.FV_FILTER_TYPE)];

    /* Group Settings */

    iVal = preferences.getInteger(DefaultPreferences.BM_NEWS_GROUPING);

    if (iVal >= 0)

      fInitialGroupType = NewsGrouping.Type.values()[iVal];

    else

      fInitialGroupType = NewsGrouping.Type.values()[fPreferences.getInteger(DefaultPreferences.FV_GROUP_TYPE)];

    /* Other Settings */

    fInitialBrowserMaximized = fPreferences.getBoolean(DefaultPreferences.FV_BROWSER_MAXIMIZED);

    fInitialLayoutVertical = fPreferences.getBoolean(DefaultPreferences.FV_LAYOUT_VERTICAL);

    fInitialWeights = fPreferences.getIntegers(DefaultPreferences.FV_SASHFORM_WEIGHTS);

    fInitialSearchTarget = NewsFilter.SearchTarget.values()[fPreferences.getInteger(DefaultPreferences.FV_SEARCH_TARGET)];

  }

  private void saveSettings() {

    /* Update Settings in DB */

    if (fCacheWeights != null && !Arrays.equals(fCacheWeights, new int[] { 50, 50 })) {

      JobRunner.runInBackgroundThread(new Runnable() {

        public void run() {

          int strWeights[] = new int[] { fCacheWeights[0], fCacheWeights[1] };

          fPreferences.putIntegers(DefaultPreferences.FV_SASHFORM_WEIGHTS, strWeights);

        }

      });

    }

  }

  private void createGlobalActions() {

    /* Hook into Reload */

    fReloadAction = new Action() {

      @Override

      public void run() {

        new ReloadTypesAction(new StructuredSelection(fInput.getMark()), getEditorSite().getShell()).run();

      }

    };

    /* Mark All Read */

    fMarkAllReadAction = new Action("Mark all News as Read") {

      @Override

      public void run() {

        new MarkReadAction(new StructuredSelection(fInput.getMark())).run();

      }

    };

    /* Select All */

    fSelectAllAction = new Action() {

      @Override

      public void run() {

        Control focusControl = fEditorSite.getShell().getDisplay().getFocusControl();

        /* Select All in Text Widget */

        if (focusControl instanceof Text) {

          ((Text) focusControl).selectAll();

        }

        /* Select All in Viewer Tree */

        else {

          ((Tree) fNewsTableControl.getViewer().getControl()).selectAll();

          fNewsTableControl.getViewer().setSelection(fNewsTableControl.getViewer().getSelection());

        }

      }

    };

    /* Delete */

    fDeleteAction = new Action() {

      @Override

      public void run() {

        new DeleteTypesAction(fParent.getShell(), (IStructuredSelection) fNewsTableControl.getViewer().getSelection()).run();

      }

    };

    /* Cut */

    fCutAction = new Action() {

      @Override

      public void run() {

        Control focusControl = fEditorSite.getShell().getDisplay().getFocusControl();

        /* Cut in Text Widget */

        if (focusControl instanceof Text)

          ((Text) focusControl).cut();

      }

    };

    /* Copy */

    fCopyAction = new Action() {

      @Override

      public void run() {

        Control focusControl = fEditorSite.getShell().getDisplay().getFocusControl();

        /* Copy in Text Widget */

        if (focusControl instanceof Text)

          ((Text) focusControl).copy();

      }

    };

    /* Paste */

    fPasteAction = new Action() {

      @Override

      public void run() {

        Control focusControl = fEditorSite.getShell().getDisplay().getFocusControl();

        /* Paste in Text Widget */

        if (focusControl instanceof Text)

          ((Text) focusControl).paste();

      }

    };

    /* Find */

    fFindAction = new Action() {

      @Override

      public void run() {

        if (fFilterBar != null)

          fFilterBar.focusQuickSearch();

      }

    };

    /* Print */

    fPrintAction = new Action() {

      @Override

      public void run() {

        if (fNewsBrowserControl != null)

          fNewsBrowserControl.getViewer().getBrowser().print();

      }

    };

  }

  private void setGlobalActions() {

    /* Define Retargetable Global Actions */

    fEditorSite.getActionBars().setGlobalActionHandler(RetargetActions.RELOAD, fReloadAction);

    fEditorSite.getActionBars().setGlobalActionHandler(RetargetActions.MARK_ALL_READ, fMarkAllReadAction);

    fEditorSite.getActionBars().setGlobalActionHandler(RetargetActions.FIND, fFindAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(), fSelectAllAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.DELETE.getId(), fDeleteAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.CUT.getId(), fCutAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.COPY.getId(), fCopyAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.PASTE.getId(), fPasteAction);

    fEditorSite.getActionBars().setGlobalActionHandler(ActionFactory.PRINT.getId(), fPrintAction);

    /* Disable some Edit-Actions at first */

    fEditorSite.getActionBars().getGlobalActionHandler(ActionFactory.CUT.getId()).setEnabled(false);

    fEditorSite.getActionBars().getGlobalActionHandler(ActionFactory.COPY.getId()).setEnabled(false);

    fEditorSite.getActionBars().getGlobalActionHandler(ActionFactory.PASTE.getId()).setEnabled(false);

  }

  /**

   * Sets the given <code>IStructuredSelection</code> to the News-Table

   * showing in the FeedView. Will ignore the selection, if the Table is

   * minimized.

   *

   * @param selection The Selection to show in the News-Table.

   */

  public void setSelection(IStructuredSelection selection) {

    /* Return if Table is not visible */

    if (!isTableViewerVisible())

      return;

    /* Remove Filter if selection is hidden */

    if (fNewsFilter.getType() != NewsFilter.Type.SHOW_ALL) {

      boolean unfilter = false;

      List<?> elements = selection.toList();

      for (Object element : elements) {

        /* Resolve the actual News */

        if (element instanceof NewsReference)

          element = ((NewsReference) element).resolve();

        /* This Element is filtered */

        if (!fNewsFilter.select(fNewsTableControl.getViewer(), null, element)) {

          unfilter = true;

          break;

        }

      }

      /* Remove Filter if selection is hidden */

      if (unfilter) {

        fNewsBrowserControl.getViewer().setBlockRefresh(true);

        try {

          fFilterBar.doFilter(NewsFilter.Type.SHOW_ALL, true, false);

        } finally {

          fNewsBrowserControl.getViewer().setBlockRefresh(false);

        }

      }

    }

    /* Apply selection to Table */

    fNewsTableControl.getViewer().setSelection(selection);

  }

  /*

   * @see org.eclipse.ui.part.EditorPart#setInput(org.eclipse.ui.IEditorInput)

   */

  @Override

  public void setInput(IEditorInput input) {

    Assert.isTrue(input instanceof FeedViewInput);

    super.setInput(input);

    /* Handle Old being hidden now */

    if (fInput != null) {

      notifyUIEvent(UIEvent.FEED_CHANGE);

      rememberSelection();

    }

    /* Remember New */

    fInput = (FeedViewInput) input;

    /* Update UI of Feed-View if new Editor */

    if (!fCreated)

      updateTab(fInput);

    /* Editor is being reused */

    if (fCreated) {

      firePropertyChange(PROP_INPUT);

      /* Load Filter Settings for this Mark if present */

      updateFilterAndGrouping(false);

      /* Cancel any previous running Cache-Job */

      Job.getJobManager().cancel(fCacheJobIdentifier);

      /* Re-Create the ContentProvider to avoid concurrency problems with Cache */

      fContentProvider = new NewsContentProvider(fNewsTableControl.getViewer(), fNewsBrowserControl.getViewer(), this);

      fNewsTableControl.getViewer().setContentProvider(fContentProvider);

      fNewsTableControl.onInputChanged(fInput);

      fNewsBrowserControl.getViewer().setContentProvider(fContentProvider);

      fNewsBrowserControl.onInputChanged(fInput);

      /* Reset the Quicksearch if active */

      if (fNewsFilter.isPatternSet())

        fNewsFilter.setPattern("");

      /* Apply Input */

      setInput(fInput.getMark(), true);

    }

  }

  /* Update Title and Image of the FeedView's Tab */

  private void updateTab(FeedViewInput input) {

    setPartName(input.getName());

    fTitleImageDescriptor = input.getImageDescriptor();

    setTitleImage(OwlUI.getImage(fResourceManager, fTitleImageDescriptor));

  }

  /**

   * Load Filter Settings for the Mark that is set as input if present

   * <p>

   * TODO Find a better solution once its possible to add listeners to

   * {@link IPreferenceScope} and then listen to changes of display-properties.

   * </p>

   *

   * @param refresh If TRUE, refresh the Viewer, FALSE otherwise.

   */

  public void updateFilterAndGrouping(boolean refresh) {

    IPreferenceScope preferences = Owl.getPreferenceService().getEntityScope(fInput.getMark());

    int iVal = preferences.getInteger(DefaultPreferences.BM_NEWS_FILTERING);

    if (iVal >= 0)

      fFilterBar.doFilter(NewsFilter.Type.values()[iVal], refresh, false);

    else

      fFilterBar.doFilter(NewsFilter.Type.values()[fPreferences.getInteger(DefaultPreferences.FV_FILTER_TYPE)], refresh, false);

    /* Load Group Settings for this Mark if present */

    iVal = preferences.getInteger(DefaultPreferences.BM_NEWS_GROUPING);

    if (iVal >= 0)

      fFilterBar.doGrouping(NewsGrouping.Type.values()[iVal], refresh, false);

    else

      fFilterBar.doGrouping(NewsGrouping.Type.values()[fPreferences.getInteger(DefaultPreferences.FV_GROUP_TYPE)], refresh, false);

  }

  /**

   * Notifies this editor about a UI-Event just occured. In dependance of the

   * event, the Editor might want to update the state on the displayed News.

   *

   * @param event The UI-Event that just occured as described in the

   * <code>UIEvent</code> enumeration.

   */

  public void notifyUIEvent(final UIEvent event) {

    final IMark inputMark = fInput.getMark();

    final boolean isBookMark = inputMark instanceof IBookMark;

    final Collection<INews> news = fContentProvider.getCachedNews();

    /*

     * News can be NULL at this moment, if the Job that is to refresh the cache

     * in the Content Provider was never scheduled. This can happen when quickly

     * navigating between feeds. Also, the input could have been deleted and the

     * editor closed. Thereby do not react.

     */

    if (news == null || !fInput.exists())

      return;

    final boolean markReadOnFeedChange = fPreferences.getBoolean(DefaultPreferences.MARK_FEED_READ_ON_CHANGE);

    final boolean markReadOnMinimize = fPreferences.getBoolean(DefaultPreferences.MARK_READ_ON_MINIMIZE);

    /* Mark *new* News as unread when closing the entire application */

    if (event == UIEvent.CLOSE && isBookMark) {

      /* Perform the State Change */

      List<INews> newsToUpdate = new ArrayList<INews>();

      for (INews newsItem : news) {

        if (newsItem.getState() == INews.State.NEW)

          newsToUpdate.add(newsItem);

      }

      INewsDAO newsDao = Owl.getPersistenceService().getDAOService().getNewsDAO();

      newsDao.setState(newsToUpdate, INews.State.UNREAD, true, false);

    }

    /* Handle seen News: Feed Change (also closing the feed view) or Minimize Event */

    else if (isBookMark || (markReadOnFeedChange && event == UIEvent.FEED_CHANGE) || (markReadOnMinimize && event == UIEvent.MINIMIZE)) {

      JobRunner.runInBackgroundThread(HANDLE_NEWS_SEEN_DELAY, new Runnable() {

        public void run() {

          /* Application might be in process of closing */

          if (Controller.getDefault().isShuttingDown())

            return;

          /* Check settings if mark as read should be performed */

          boolean markRead = false;

          if (event == UIEvent.FEED_CHANGE)

            markRead = markReadOnFeedChange;

          else if (event == UIEvent.MINIMIZE)

            markRead = markReadOnMinimize;

          /* Perform the State Change */

          List<INews> newsToUpdate = new ArrayList<INews>();

          for (INews newsItem : news) {

            if (newsItem.getState() == INews.State.NEW)

              newsToUpdate.add(newsItem);

            else if (markRead && (newsItem.getState() == INews.State.UPDATED || newsItem.getState() == INews.State.UNREAD))

              newsToUpdate.add(newsItem);

          }

          /* Force quick update on Feed-Change */

          if (event == UIEvent.FEED_CHANGE && !newsToUpdate.isEmpty())

            Controller.getDefault().getSavedSearchService().forceQuickUpdate();

          INewsDAO newsDao = Owl.getPersistenceService().getDAOService().getNewsDAO();

          newsDao.setState(newsToUpdate, markRead ? INews.State.READ : INews.State.UNREAD, true, false);

          /* Retention Strategy */

          if (isBookMark)

            RetentionStrategy.process((IBookMark) inputMark, news);

        }

      });

    }

  }

  /* React on the Input being set */

  private void onInputSet() {

    /* Check if an action is to be performed */

    PerformAfterInputSet perform = fInput.getPerformOnInputSet();

    if (perform != null) {

      /* Select first News */

      if (perform.getType() == PerformAfterInputSet.Types.SELECT_FIRST_NEWS)

        navigate(false, true, true, false);

      /* Select first unread News */

      else if (perform.getType() == PerformAfterInputSet.Types.SELECT_UNREAD_NEWS)

        navigate(false, true, true, true);

      /* Select specific News */

      else if (perform.getType() == PerformAfterInputSet.Types.SELECT_SPECIFIC_NEWS)

        setSelection(new StructuredSelection(perform.getNewsToSelect()));

      /* Make sure to activate this FeedView in case of an action */

      if (perform.shouldActivate())

        fEditorSite.getPage().activate(fEditorSite.getPart());

    }

    /* DB Roundtrips done in the background */

    JobRunner.runInBackgroundThread(new Runnable() {

      public void run() {

        if (fInput == null)

          return;

        IMark mark = fInput.getMark();

        /* Trigger a reload if this is the first time open */

        if (mark instanceof IBookMark) {

          IBookMark bookmark = (IBookMark) mark;

          if ((bookmark.getLastVisitDate() == null && !fContentProvider.hasCachedNews()))

            new ReloadTypesAction(new StructuredSelection(mark), getEditorSite().getShell()).run();

        }

        /* Update some fields due to displaying the mark */

        if (mark instanceof ISearchMark) {

          DynamicDAO.getDAO(ISearchMarkDAO.class).visited((ISearchMark) mark);

        }

        /* TODO Fixme once IBookMarkDAO.visited() is implemented */

        else {

          mark.setPopularity(mark.getPopularity() + 1);

          mark.setLastVisitDate(new Date(System.currentTimeMillis()));

          DynamicDAO.save(mark);

        }

      }

    });

  }

  /* Set Input to Viewers */

  private void setInput(final IMark mark, final boolean reused) {

    /* Update Cache in Background and then apply to UI */

    JobRunner.runUIUpdater(new UIBackgroundJob(fParent) {

      private IProgressMonitor fBgMonitor;

      @Override

      public boolean belongsTo(Object family) {

        return fCacheJobIdentifier.equals(family);

      }

      @Override

      protected void runInBackground(IProgressMonitor monitor) {

        fBgMonitor = monitor;

        if (!monitor.isCanceled())

          fContentProvider.refreshCache(new IMark[] { mark }, false);

      }

      @Override

      protected void runInUI(IProgressMonitor monitor) {

        IStructuredSelection oldSelection = null;

        Object value = fgSelectionCache.get(fInput.hashCode());

        if (value != null)

          oldSelection = new StructuredSelection(value);

        /* Set input to News-Table if Visible */

        if (!fBgMonitor.isCanceled() && isTableViewerVisible())

          stableSetInputToNewsTable(mark, oldSelection);

        /* Clear old Input from Table */

        else if (!fBgMonitor.isCanceled() && reused)

          fNewsTableControl.setPartInput(null);

        /* Set input to News-Browser if visible */

        if (!fBgMonitor.isCanceled() && (!isTableViewerVisible() || (BROWSER_SHOWS_ALL && oldSelection == null)))

          fNewsBrowserControl.setPartInput(mark);

        /* Reset old Input to Browser if availabel */

        else if (!fBgMonitor.isCanceled() && oldSelection != null)

          fNewsBrowserControl.setPartInput(oldSelection.getFirstElement());

        /* Clear old Input from Browser */

        else if (!fBgMonitor.isCanceled() && reused)

          fNewsBrowserControl.setPartInput(null);

        /* Update Tab now */

        if (reused)

          updateTab(fInput);

        /* Handle Input being set now */

        onInputSet();

      }

    });

  }

  /*

   * @see org.eclipse.ui.part.EditorPart#isDirty()

   */

  @Override

  public boolean isDirty() {

    return false;

  }

  /*

   * @see org.eclipse.ui.part.EditorPart#isSaveAsAllowed()

   */

  @Override

  public boolean isSaveAsAllowed() {

    return false;

  }

  /*

   * @see org.eclipse.ui.part.WorkbenchPart#setFocus()

   */

  @Override

  public void setFocus() {

    if (isTableViewerVisible())

      fNewsTableControl.setFocus();

    else

      fNewsBrowserControl.setFocus();

  }

  @Override

  public void dispose() {

    saveSettings();

    unregisterListeners();

    super.dispose();

    fContentProvider.dispose();

    fNewsTableControl.dispose();

    fNewsBrowserControl.dispose();

    fResourceManager.dispose();

  }

  private void unregisterListeners() {

    fEditorSite.getPage().removePartListener(fPartListener);

    DynamicDAO.removeEntityListener(IBookMark.class, fBookMarkListener);

    DynamicDAO.removeEntityListener(ISearchMark.class, fSearchMarkListener);

    DynamicDAO.removeEntityListener(IFeed.class, fFeedListener);

    DynamicDAO.removeEntityListener(ISearchCondition.class, fSearchConditionListener);

  }

  /**

   * Toggle between vertical and horizontal Layout.

   * <p>

   * TODO This needs to be optimized!

   * </p>

   */

  void toggleLayout() {

    int orientation = fSashForm.getOrientation();

    /* Horizontal Alignment */

    if ((orientation & SWT.VERTICAL) != 0) {

      fBrowserSep.setVisible(fBrowserBar.isVisible());

      fSashForm.setOrientation(SWT.HORIZONTAL);

      fSashForm.setBackground(fSashForm.getDisplay().getSystemColor(SWT.COLOR_GRAY));

      ((GridData) fTableBrowserSep.getLayoutData()).exclude = true;

      fTableBrowserSep.getParent().layout();

    }

    /* Vertical Alignment (default) */

    else {

      fBrowserSep.setVisible(true);

      fSashForm.setOrientation(SWT.VERTICAL);

      fSashForm.setBackground(null);

      ((GridData) fTableBrowserSep.getLayoutData()).exclude = false;

      fTableBrowserSep.getParent().layout();

    }

    /* Update Settings */

    JobRunner.runInBackgroundThread(new Runnable() {

      public void run() {

        fPreferences.putBoolean(DefaultPreferences.FV_LAYOUT_VERTICAL, (fSashForm.getOrientation() & SWT.VERTICAL) != 0);

      }

    });

  }

  /**

   * Toggle between maximized and normal Browser-Control.

   */

  void toggleNewsViewMaximized() {

    final boolean isMaximized = !isTableViewerVisible();

    /* Maximize Browser */

    if (!isMaximized) {

      fSashForm.setMaximizedControl(fBrowserViewerControlContainer);

      fNewsTableControl.getViewer().setSelection(StructuredSelection.EMPTY);

      fNewsBrowserControl.setPartInput(fInput.getMark());

      fNewsTableControl.setPartInput(null);

      fNewsBrowserControl.setFocus();

    }

    /* Restore Table */

    else {

      ((GridData) fBrowserSep.getLayoutData()).exclude = false;

      fSashForm.setMaximizedControl(null);

      fNewsTableControl.setPartInput(fInput.getMark());

      expandNewsTableViewerGroups(true, StructuredSelection.EMPTY);

      fNewsBrowserControl.setPartInput(null);

      fNewsTableControl.setFocus();

    }

    /* Update Settings */

    JobRunner.runInBackgroundThread(new Runnable() {

      public void run() {

        fPreferences.putBoolean(DefaultPreferences.FV_BROWSER_MAXIMIZED, !isMaximized);

      }

    });

  }

  /**

   * Refreshes all parts of this editor.

   *

   * @param delayRedraw If <code>TRUE</code> delay redraw until operation is

   * done.

   * @param updateLabels If <code>TRUE</code> update all Labels.

   */

  void refresh(boolean delayRedraw, boolean updateLabels) {

    refreshTableViewer(delayRedraw, updateLabels);

    refreshBrowserViewer();

  }

  /**

   * A special key was pressed from the Quicksearch Input-Field. Handle it.

   *

   * @param traversal The Traversal that occured from the quicksearch.

   */

  void handleQuicksearchTraversalEvent(int traversal) {

    /* Enter was hit */

    if ((traversal & SWT.TRAVERSE_RETURN) != 0) {

      /* Select and Focus TreeViewer */

      if (isTableViewerVisible()) {

        Tree tree = (Tree) fNewsTableControl.getViewer().getControl();

        if (tree.getItemCount() > 0) {

          fNewsTableControl.getViewer().setSelection(new StructuredSelection(tree.getItem(0).getData()));

          fNewsTableControl.setFocus();

        }

      }

      /* Move Focus into BrowserViewer */

      else {

        fNewsBrowserControl.setFocus();

      }

    }

    /* Page Up / Down was hit */

    else if ((traversal & SWT.TRAVERSE_PAGE_NEXT) != 0 || (traversal & SWT.TRAVERSE_PAGE_PREVIOUS) != 0) {

      setFocus();

    }

  }

  /* Refresh Table-Viewer if visible */

  private void refreshTableViewer(boolean delayRedraw, boolean updateLabels) {

    if (isTableViewerVisible()) {

      boolean groupingEnabled = fNewsGrouping.getType() != NewsGrouping.Type.NO_GROUPING;

      /* Remember Selection if grouping enabled */

      ISelection selection = StructuredSelection.EMPTY;

      if (groupingEnabled)

        selection = fNewsTableControl.getViewer().getSelection();

      /* Delay redraw operations if requested */

      if (delayRedraw)

        fNewsTableControl.getViewer().getControl().getParent().setRedraw(false);

      try {

        /* Refresh */

        fNewsTableControl.getViewer().refresh(updateLabels);

        /* Expand all Groups if grouping is enabled */

        if (groupingEnabled)

          expandNewsTableViewerGroups(false, selection);

      }

      /* Redraw now if delayed before */

      finally {

        if (delayRedraw)

          fNewsTableControl.getViewer().getControl().getParent().setRedraw(true);

      }

    }

  }

  private void expandNewsTableViewerGroups(boolean delayRedraw, ISelection oldSelection) {

    TreeViewer viewer = fNewsTableControl.getViewer();

    Tree tree = (Tree) viewer.getControl();

    /* Remember TopItem if required */

    TreeItem topItem = oldSelection.isEmpty() ? tree.getTopItem() : null;

    /* Expand All & Restore Selection with redraw false */

    if (delayRedraw)

      tree.getParent().setRedraw(false);

    try {

      viewer.expandAll();

      /* Restore selection if required */

      if (!oldSelection.isEmpty() && viewer.getSelection().isEmpty())

        viewer.setSelection(oldSelection, true);

      else if (topItem != null)

        tree.setTopItem(topItem);

    } finally {

      if (delayRedraw)

        tree.getParent().setRedraw(true);

    }

  }

  /* TODO This is a Workaround until Eclipse Bug #159586 is fixed */

  private void stableSetInputToNewsTable(Object input, ISelection oldSelection) {

    TreeViewer viewer = fNewsTableControl.getViewer();

    Tree tree = (Tree) viewer.getControl();

    /* Set Input & Restore Selection with redraw false */

    tree.getParent().setRedraw(false);

    try {

      fNewsTableControl.setPartInput(input);

      /* Restore selection if required */

      if (oldSelection != null) {

        fNewsTableControl.setBlockNewsStateTracker(true);

        try {

          viewer.setSelection(oldSelection);

        } finally {

          fNewsTableControl.setBlockNewsStateTracker(false);

        }

      }

      /* Set Top Item */

      if (tree.getItemCount() > 0)

        tree.setTopItem(tree.getItem(0));

    } finally {

      tree.getParent().setRedraw(true);

    }

  }

  private void rememberSelection() {

    IStructuredSelection sel = (IStructuredSelection) fNewsTableControl.getViewer().getSelection();

    if (!sel.isEmpty()) {

      Object obj = sel.getFirstElement();

      if (obj instanceof INews)

        fgSelectionCache.put(fInput.hashCode(), new NewsReference(((INews) obj).getId()));

      else

        fgSelectionCache.remove(fInput.hashCode());

    }

  }

  /* Refresh Browser-Viewer */

  private void refreshBrowserViewer() {

    fNewsBrowserControl.getViewer().refresh();

  }

  /**

   * Check wether the News-Table-Part of this Editor is visible or not

   * (minmized).

   *

   * @return TRUE if the News-Table-Part is visible, FALSE otherwise.

   */

  boolean isTableViewerVisible() {

    return fSashForm.getMaximizedControl() == null;

  }

  /**

   * Get the shared ViewerFilter used to filter News.

   *

   * @return the shared ViewerFilter used to filter News.

   */

  NewsFilter getFilter() {

    return fNewsFilter;

  }

  /**

   * Get the shared Viewer-Grouper used to group News.

   *

   * @return the shared Viewer-Grouper used to group News.

   */

  NewsGrouping getGrouper() {

    return fNewsGrouping;

  }

  NewsBrowserControl getNewsBrowserControl() {

    return fNewsBrowserControl;

  }

  /*

   * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)

   */

  @Override

  public void createPartControl(Composite parent) {

    fCreated = true;

    fParent = parent;

    /* Shared Viewer Helper */

    fNewsFilter = new NewsFilter();

    fNewsFilter.setType(fInitialFilterType);

    fNewsFilter.setSearchTarget(fInitialSearchTarget);

    fNewsGrouping = new NewsGrouping();

    fNewsGrouping.setType(fInitialGroupType);

    /* Top-Most root Composite in Editor */

    Composite rootComposite = new Composite(fParent, SWT.NONE);

    rootComposite.setLayout(LayoutUtils.createGridLayout(1, 0, 0));

    ((GridLayout) rootComposite.getLayout()).verticalSpacing = 0;

    /* FilterBar */

    fFilterBar = new FilterBar(this, rootComposite);

    /* Separate from SashForm */

    Label sep = new Label(rootComposite, SWT.SEPARATOR | SWT.HORIZONTAL);

    sep.setLayoutData(new GridData(SWT.FILL, SWT.BEGINNING, true, false));

    /* SashForm dividing Feed and News View */

    fSashForm = new SashForm(rootComposite, (fInitialLayoutVertical ? SWT.VERTICAL : SWT.HORIZONTAL) | SWT.SMOOTH);

    fSashForm.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

    if (!fInitialLayoutVertical)

      fSashForm.setBackground(fSashForm.getDisplay().getSystemColor(SWT.COLOR_GRAY));

    /* Table-Viewer to display headlines */

    NewsTableViewer tableViewer;

    {

      Composite container = new Composite(fSashForm, SWT.None);

      container.setLayout(LayoutUtils.createGridLayout(1, 0, 0, 0, 5, false));

      container.addControlListener(new ControlAdapter() {

        @Override

        public void controlResized(ControlEvent e) {

          fCacheWeights = fSashForm.getWeights();

        }

      });

      fNewsTableControl = new NewsTableControl();

      fNewsTableControl.init(fEditorSite);

      fNewsTableControl.onInputChanged(fInput);

      /* Create Viewer */

      tableViewer = fNewsTableControl.createViewer(container);

      /* Clear any quicksearch when ESC is hit from the Tree */

      tableViewer.getControl().addKeyListener(new KeyAdapter() {

        @Override

        public void keyPressed(KeyEvent e) {

          if (e.keyCode == SWT.ESC)

            fFilterBar.clearQuickSearch();

        }

      });

      /* Separate from Browser-Viewer */

      fTableBrowserSep = new Label(container, SWT.SEPARATOR | SWT.HORIZONTAL);

      fTableBrowserSep.setLayoutData(new GridData(SWT.FILL, SWT.BEGINNING, true, false));

      ((GridData) fTableBrowserSep.getLayoutData()).exclude = !fInitialLayoutVertical;

    }

    /* Browser-Viewer to display news */

    NewsBrowserViewer browserViewer;

    {

      fBrowserViewerControlContainer = new Composite(fSashForm, SWT.None);

      fBrowserViewerControlContainer.setLayout(LayoutUtils.createGridLayout(1, 0, 0, 0, 5, false));

      fBrowserViewerControlContainer.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_WHITE));

      /* Browser Bar for Navigation */

      fBrowserBar = new BrowserBar(this, fBrowserViewerControlContainer);

      /* Separate to Browser */

      fBrowserSep = new Label(fBrowserViewerControlContainer, SWT.SEPARATOR | SWT.HORIZONTAL);

      fBrowserSep.setLayoutData(new GridData(SWT.FILL, SWT.BEGINNING, true, false));

      ((GridData) fBrowserSep.getLayoutData()).exclude = fInitialBrowserMaximized && !fBrowserBar.isVisible();

      fBrowserSep.setVisible(fBrowserBar.isVisible() || (fSashForm.getOrientation() & SWT.VERTICAL) != 0);

      fNewsBrowserControl = new NewsBrowserControl();

      fNewsBrowserControl.init(fEditorSite);

      fNewsBrowserControl.onInputChanged(fInput);

      /* Create Viewer */

      browserViewer = fNewsBrowserControl.createViewer(fBrowserViewerControlContainer);

      /* Clear any quicksearch when ESC is hit from the Tree */

      browserViewer.getControl().addKeyListener(new KeyAdapter() {

        @Override

        public void keyPressed(KeyEvent e) {

          if (e.keyCode == SWT.ESC)

            fFilterBar.clearQuickSearch();

        }

      });

      /* Init the Browser Bar with the CBrowser */

      fBrowserBar.init(browserViewer.getBrowser());

    }

    /* SashForm weights */

    fSashForm.setWeights(fInitialWeights);

    if (fInitialBrowserMaximized)

      fSashForm.setMaximizedControl(fBrowserViewerControlContainer);