Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.pde.internal.ui.editor
Class LinkSection  view LinkSection download LinkSection.java

java.lang.Object
  extended byorg.eclipse.ui.forms.AbstractFormPart
      extended byorg.eclipse.ui.forms.SectionPart
          extended byorg.eclipse.pde.internal.ui.editor.PDESection
              extended byorg.eclipse.pde.internal.ui.editor.LinkSection
All Implemented Interfaces:
IContextPart, org.eclipse.ui.forms.IFormPart, org.eclipse.pde.core.IModelChangedListener

public class LinkSection
extends PDESection

This class can be used to show a standard section with an array of links. Links are objects from editor pages, and each one will select the owning page and reveal the element in it. If the number of objects from the content provider is greated than the preset limit, only the first 'limit' number of links will be shown, and a 'More...' button will show up (this is a change from 2.1 where 'More...' was visible all the time).


Nested Class Summary
(package private)  class LinkSection.LinkHandler
           
 
Field Summary
private  org.eclipse.swt.widgets.Composite container
           
private  org.eclipse.jface.viewers.IStructuredContentProvider contentProvider
           
private  org.eclipse.pde.internal.ui.parts.ILinkLabelProvider labelProvider
           
private  org.eclipse.swt.widgets.Composite linkContainer
           
private  LinkSection.LinkHandler linkHandler
           
private  int linkNumberLimit
           
private  org.eclipse.swt.widgets.Button moreButton
           
private  java.lang.String morePageId
           
 
Fields inherited from class org.eclipse.pde.internal.ui.editor.PDESection
CLIENT_VSPACING
 
Fields inherited from class org.eclipse.ui.forms.SectionPart
 
Fields inherited from class org.eclipse.ui.forms.AbstractFormPart
 
Constructor Summary
LinkSection(PDEFormPage page, org.eclipse.swt.widgets.Composite parent, int style)
           
 
Method Summary
 void add(java.lang.Object[] links)
           
protected  void createClient(org.eclipse.ui.forms.widgets.Section section, org.eclipse.ui.forms.widgets.FormToolkit toolkit)
           
private  void createLink(java.lang.Object object)
           
private  void createLinks()
           
private  void createMoreButton()
           
private  void disposeLink(java.lang.Object obj)
           
private  void doEnter(org.eclipse.ui.forms.widgets.Hyperlink link)
           
private  void doExit(org.eclipse.ui.forms.widgets.Hyperlink link)
           
protected  void doLinkActivated(org.eclipse.ui.forms.widgets.Hyperlink link)
           
private  org.eclipse.ui.forms.widgets.Hyperlink find(java.lang.Object object)
           
private  void reflow()
           
 void refresh()
          Refreshes the section after becoming stale (falling behind data in the model).
 void remove(java.lang.Object[] links)
           
 void setContentProvider(org.eclipse.jface.viewers.IStructuredContentProvider contentProvider)
           
 void setLabelProvider(org.eclipse.pde.internal.ui.parts.ILinkLabelProvider provider)
           
 void setLinkNumberLimit(int limit)
           
 void setMorePageId(java.lang.String id)
           
private  void update(org.eclipse.ui.forms.widgets.Hyperlink hyperlink, java.lang.Object object)
           
private  void update(java.lang.Object object)
           
 void update(java.lang.Object[] links)
           
private  void updateMoreState(boolean needMore)
           
 
Methods inherited from class org.eclipse.pde.internal.ui.editor.PDESection
cancelEdit, canPaste, doGlobalAction, fireSaveNeeded, getContextId, getPage, isEditable, modelChanged
 
Methods inherited from class org.eclipse.ui.forms.SectionPart
expansionStateChanged, expansionStateChanging, getSection, hookListeners, setFocus
 
Methods inherited from class org.eclipse.ui.forms.AbstractFormPart
commit, dispose, getManagedForm, initialize, isDirty, isStale, markDirty, markStale, setFormInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

labelProvider

private org.eclipse.pde.internal.ui.parts.ILinkLabelProvider labelProvider

contentProvider

private org.eclipse.jface.viewers.IStructuredContentProvider contentProvider

linkContainer

private org.eclipse.swt.widgets.Composite linkContainer

container

private org.eclipse.swt.widgets.Composite container

moreButton

private org.eclipse.swt.widgets.Button moreButton

morePageId

private java.lang.String morePageId

linkNumberLimit

private int linkNumberLimit

linkHandler

private LinkSection.LinkHandler linkHandler
Constructor Detail

LinkSection

public LinkSection(PDEFormPage page,
                   org.eclipse.swt.widgets.Composite parent,
                   int style)
Method Detail

createClient

protected void createClient(org.eclipse.ui.forms.widgets.Section section,
                            org.eclipse.ui.forms.widgets.FormToolkit toolkit)
Specified by:
createClient in class PDESection

createMoreButton

private void createMoreButton()

add

public void add(java.lang.Object[] links)

remove

public void remove(java.lang.Object[] links)

disposeLink

private void disposeLink(java.lang.Object obj)

find

private org.eclipse.ui.forms.widgets.Hyperlink find(java.lang.Object object)

update

public void update(java.lang.Object[] links)

update

private void update(java.lang.Object object)

update

private void update(org.eclipse.ui.forms.widgets.Hyperlink hyperlink,
                    java.lang.Object object)

refresh

public void refresh()
Description copied from class: org.eclipse.ui.forms.AbstractFormPart
Refreshes the section after becoming stale (falling behind data in the model). Subclasses must call 'super' when overriding this method.


reflow

private void reflow()

createLinks

private void createLinks()

updateMoreState

private void updateMoreState(boolean needMore)

createLink

private void createLink(java.lang.Object object)

doEnter

private void doEnter(org.eclipse.ui.forms.widgets.Hyperlink link)

doExit

private void doExit(org.eclipse.ui.forms.widgets.Hyperlink link)

doLinkActivated

protected void doLinkActivated(org.eclipse.ui.forms.widgets.Hyperlink link)

setMorePageId

public void setMorePageId(java.lang.String id)

setLinkNumberLimit

public void setLinkNumberLimit(int limit)

setContentProvider

public void setContentProvider(org.eclipse.jface.viewers.IStructuredContentProvider contentProvider)

setLabelProvider

public void setLabelProvider(org.eclipse.pde.internal.ui.parts.ILinkLabelProvider provider)