de.cau.cs.kieler.kiml.ui.views
Class LayoutViewPart

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.ViewPart
              extended by de.cau.cs.kieler.kiml.ui.views.LayoutViewPart
All Implemented Interfaces:
EventListener, IAdaptable, IExecutableExtension, IPersistable, ISelectionListener, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class LayoutViewPart
extends ViewPart
implements ISelectionListener

A view that displays layout options for selected objects.

Rating proposed yellow
(2009-12-11) msp

Field Summary
static String PREF_ADVANCED
          preference identifier for enabling advanced options.
static String PREF_CATEGORIES
          preference identifier for enabling categories.
static String VIEW_ID
          the view identifier.
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
LayoutViewPart()
           
 
Method Summary
 void createPartControl(Composite parent)
          
 void dispose()
          
static LayoutViewPart findView()
          Finds the active layout view, if it exists.
 Control getControl()
          Returns the control that is handled by this view part.
 Object getCurrentEditPart()
          Returns the first edit part in the current selection for which options are shown.
 LayoutAlgorithmData[] getCurrentLayouterData()
          Returns the current layout algorithm data.
 IWorkbenchPart getCurrentPart()
          Returns the currently active workbench part that is tracked by the layout view.
 List<IPropertySheetEntry> getSelection()
          Returns the current selection of the layout view.
 void refresh()
          Refreshes the layout view asynchronously.
 void selectionChanged(IWorkbenchPart part, ISelection selection)
          
 void setFocus()
          
 
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

VIEW_ID

public static final String VIEW_ID
the view identifier.

See Also:
Constant Field Values

PREF_CATEGORIES

public static final String PREF_CATEGORIES
preference identifier for enabling categories.

See Also:
Constant Field Values

PREF_ADVANCED

public static final String PREF_ADVANCED
preference identifier for enabling advanced options.

See Also:
Constant Field Values
Constructor Detail

LayoutViewPart

public LayoutViewPart()
Method Detail

findView

public static LayoutViewPart findView()
Finds the active layout view, if it exists.

Returns:
the active layout view, or null if there is none

createPartControl

public void createPartControl(Composite parent)

Specified by:
createPartControl in interface IWorkbenchPart
Specified by:
createPartControl in class WorkbenchPart

setFocus

public void setFocus()

Specified by:
setFocus in interface IWorkbenchPart
Specified by:
setFocus in class WorkbenchPart

getControl

public Control getControl()
Returns the control that is handled by this view part.

Returns:
the control

dispose

public void dispose()

Specified by:
dispose in interface IWorkbenchPart
Overrides:
dispose in class WorkbenchPart

refresh

public void refresh()
Refreshes the layout view asynchronously.


selectionChanged

public void selectionChanged(IWorkbenchPart part,
                             ISelection selection)

Specified by:
selectionChanged in interface ISelectionListener

getSelection

public List<IPropertySheetEntry> getSelection()
Returns the current selection of the layout view.

Returns:
the selected property sheet entries

getCurrentEditPart

public Object getCurrentEditPart()
Returns the first edit part in the current selection for which options are shown.

Returns:
the selected edit part, or null if there is none

getCurrentPart

public IWorkbenchPart getCurrentPart()
Returns the currently active workbench part that is tracked by the layout view.

Returns:
the current workbench part, or null if there is none

getCurrentLayouterData

public LayoutAlgorithmData[] getCurrentLayouterData()
Returns the current layout algorithm data.

Returns:
the current layout algorithm data