org.eclipse.ptp.ui.views
Class AbstractParallelElementView

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.ui.part.WorkbenchPart
          org.eclipse.ui.part.ViewPart
              org.eclipse.ptp.ui.views.AbstractParallelView
                  org.eclipse.ptp.ui.views.AbstractParallelElementView

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.viewers.ISelectionChangedListener, IContentProvider, IIconCanvasActionListener, IImageProvider, IToolTipProvider, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

Direct Known Subclasses:

AbstractParallelSetView

public abstract class AbstractParallelElementView
extends AbstractParallelView
implements IIconCanvasActionListener, IToolTipProvider, IImageProvider, IContentProvider, org.eclipse.jface.viewers.ISelectionChangedListener

Field Summary

protected ElementIconCanvas	canvas
protected IElementSet	cur_element_set
protected int	cur_set_size
protected String	DEFAULT_TITLE
protected String	EMPTY_TITLE
protected org.eclipse.ptp.ui.views.AbstractParallelElementView.IconRefreshWorkbenchJob	iconreFreshJob
protected IElementManager	manager
protected org.eclipse.core.runtime.Preferences.IPropertyChangeListener	propertyChangeListener update preference setting
protected org.eclipse.swt.graphics.Color	registerColor

Fields inherited from interface org.eclipse.ptp.ui.views.IIconCanvasActionListener

COPY_ACTION, CUT_ACTION, DELETE_ACTION, DOUBLE_CLICK_ACTION, PASTE_ACTION

Fields inherited from interface org.eclipse.ptp.ui.views.IToolTipProvider

NO_TOOLTIP

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

AbstractParallelElementView(IElementManager manager)

Method Summary

void	build()
protected void	changeTitle(String message) Change view title
protected void	changeTitle(String title, String setName, int size) Change view title
protected abstract Object	convertElementObject(IElement element) Find actual object
protected org.eclipse.swt.widgets.Composite	createElementView(org.eclipse.swt.widgets.Composite parent) Create element videw
void	createPartControl(org.eclipse.swt.widgets.Composite parent)
protected void	createView(org.eclipse.swt.widgets.Composite parent) Create Element View
void	dispose()
protected abstract void	doubleClick(IElement element) Double click action
void	drawSpecial(Object obj, int index, org.eclipse.swt.graphics.GC gc, int x_loc, int y_loc, int width, int height) Draw special on the image
void	fireSetChangeEvent(IElementSet cur_set, IElementSet pre_set) Fire set change event
IElementHandler	getCurrentElementHandler() Get current element handler
abstract String	getCurrentID() Get current ID
IElementSet	getCurrentSet() Get current set
String	getCurrentSetID() Get current set ID
IElementHandler	getElementHandler(String id)
Object	getObject(int index) IContentProvider
String	getRulerIndex(Object obj, int index) Get index of left hand element
org.eclipse.jface.viewers.ISelection	getSelection()
org.eclipse.swt.graphics.Image	getStatusIcon(Object obj, int index, boolean isSelected) Image Provider
protected abstract String[]	getToolTipText(Object obj) Get tooltip text
IElementManager	getUIManager() Get IElementManager
void	handleAction(int type, int index) IIconCanvasActionListener
protected abstract void	initialElement() Initial elements setting
protected abstract void	initialView() Initial view setting
boolean	isDisplayRuler() Is ruler displayed
void	refresh(boolean all)
void	refresh(boolean all, boolean force) Refresh view
void	selectSet(IElementSet set) Select set
void	setDisplayRuler(boolean showRuler) Show ruler
void	setFocus()
void	setRegisterColor(org.eclipse.swt.graphics.Color color) Set the color of registered element
String[]	toolTipText(Object obj) IToolTipProvider
abstract void	update() Update view details
void	update(Object obj, String content)
abstract void	updateAction()
abstract void	updateTitle() Update view title

Methods inherited from class org.eclipse.ptp.ui.views.AbstractParallelView

asyncExec, becomesHidden, becomesVisible, deregisterPartListener, getDisplay, isVisible, registerPartListener, repaint, showWhile, syncExec

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.ptp.ui.views.IIconCanvasActionListener

handleAction

Methods inherited from interface org.eclipse.jface.viewers.ISelectionChangedListener

selectionChanged

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

DEFAULT_TITLE

protected final String DEFAULT_TITLE

manager

protected IElementManager manager

cur_element_set

protected IElementSet cur_element_set

cur_set_size

protected int cur_set_size

canvas

protected ElementIconCanvas canvas

EMPTY_TITLE

protected final String EMPTY_TITLE

See Also:

Constant Field Values

registerColor

protected org.eclipse.swt.graphics.Color registerColor

iconreFreshJob

protected org.eclipse.ptp.ui.views.AbstractParallelElementView.IconRefreshWorkbenchJob iconreFreshJob

propertyChangeListener

protected org.eclipse.core.runtime.Preferences.IPropertyChangeListener propertyChangeListener

update preference setting

Constructor Detail

AbstractParallelElementView

public AbstractParallelElementView(IElementManager manager)

Method Detail

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Specified by:

createPartControl in class org.eclipse.ui.part.WorkbenchPart

setRegisterColor

public void setRegisterColor(org.eclipse.swt.graphics.Color color)

Set the color of registered element

Parameters:

color -

createView

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

Create Element View

Parameters:

parent -

getUIManager

public IElementManager getUIManager()

Get IElementManager

Returns:

IElementManager

getElementHandler

public IElementHandler getElementHandler(String id)

getCurrentElementHandler

public IElementHandler getCurrentElementHandler()

Get current element handler

Returns:

IElementHandler

changeTitle

protected void changeTitle(String title,
                           String setName,
                           int size)

Change view title

Parameters:

title - title

setName - set name

size - element size

changeTitle

protected void changeTitle(String message)

Change view title

Parameters:

message - Message of title

createElementView

protected org.eclipse.swt.widgets.Composite createElementView(org.eclipse.swt.widgets.Composite parent)

Create element videw

Parameters:

parent - parent composite

Returns:

composite

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.ui.part.WorkbenchPart

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Specified by:

setFocus in class org.eclipse.ui.part.WorkbenchPart

getCurrentSetID

public String getCurrentSetID()

Get current set ID

Returns:

current set ID

fireSetChangeEvent

public void fireSetChangeEvent(IElementSet cur_set,
                               IElementSet pre_set)

Fire set change event

Parameters:

cur_set - current set

pre_set - previous set

selectSet

public void selectSet(IElementSet set)

Select set

Parameters:

set - Target set

getCurrentSet

public IElementSet getCurrentSet()

Get current set

Returns:

current set

build

public void build()

refresh

public void refresh(boolean all,
                    boolean force)

Refresh view

refresh

public void refresh(boolean all)

updateAction

public abstract void updateAction()

initialView

protected abstract void initialView()

Initial view setting

initialElement

protected abstract void initialElement()

Initial elements setting

update

public abstract void update()

Update view details

updateTitle

public abstract void updateTitle()

Update view title

getCurrentID

public abstract String getCurrentID()

Get current ID

Returns:

element ID

doubleClick

protected abstract void doubleClick(IElement element)

Double click action

Parameters:

element - Target element

getToolTipText

protected abstract String[] getToolTipText(Object obj)

Get tooltip text

Parameters:

obj - Selected element

Returns:

text of tooltip

convertElementObject

protected abstract Object convertElementObject(IElement element)

Find actual object

Parameters:

element - Target element

Returns:

object represent of element

getObject

public Object getObject(int index)

IContentProvider

Specified by:

getObject in interface IContentProvider

Parameters:

index - element index

Returns:

element

getRulerIndex

public String getRulerIndex(Object obj,
                            int index)

Description copied from interface: IContentProvider

Get index of left hand element

Specified by:

getRulerIndex in interface IContentProvider

Parameters:

obj - Target element

index - element index

Returns:

element ID

toolTipText

public String[] toolTipText(Object obj)

IToolTipProvider

Specified by:

toolTipText in interface IToolTipProvider

Parameters:

obj - Selected element

Returns:

content of tooltip

update

public void update(Object obj,
                   String content)

Specified by:

update in interface IToolTipProvider

getStatusIcon

public org.eclipse.swt.graphics.Image getStatusIcon(Object obj,
                                                    int index,
                                                    boolean isSelected)

Image Provider

Specified by:

getStatusIcon in interface IImageProvider

Parameters:

obj - Target element

index - Tagret index position

isSelected - whether it is selected or not

Returns:

Image

drawSpecial

public void drawSpecial(Object obj,
                        int index,
                        org.eclipse.swt.graphics.GC gc,
                        int x_loc,
                        int y_loc,
                        int width,
                        int height)

Description copied from interface: IImageProvider

Draw special on the image

Specified by:

drawSpecial in interface IImageProvider

Parameters:

obj - Target element

index - Tagret index position

gc - GC

x_loc - x coordinate

y_loc - y corrdinate

width - image size

height - image height

handleAction

public void handleAction(int type,
                         int index)

IIconCanvasActionListener

Specified by:

handleAction in interface IIconCanvasActionListener

Parameters:

type - action type

index - element index

setDisplayRuler

public void setDisplayRuler(boolean showRuler)

Show ruler

Parameters:

showRuler - true if show ruler

isDisplayRuler

public boolean isDisplayRuler()

Is ruler displayed

Returns:

true if ruler is displayed

getSelection

public org.eclipse.jface.viewers.ISelection getSelection()