org.gudy.azureus2.ui.swt.views
Interface IView

All Superinterfaces:
org.gudy.azureus2.ui.swt.IconBarEnabler, org.gudy.azureus2.ui.swt.mainwindow.Refreshable
All Known Implementing Classes:
AbstractIView, PluginView, UISWTPluginView

public interface IView
extends org.gudy.azureus2.ui.swt.IconBarEnabler, org.gudy.azureus2.ui.swt.mainwindow.Refreshable

Author:
Olivier

Method Summary
 void dataSourceChanged(java.lang.Object newDataSource)
          Called when the selected dataSource has changed.
 void delete()
          This method is caled when the view is destroyed.
 void generateDiagnostics(org.gudy.azureus2.core3.util.IndentWriter writer)
          Called when Azureus generates Diagnostics.
 org.eclipse.swt.widgets.Composite getComposite()
          This method is called after initialize so that the Tab is set its control Caller is the GUI Thread.
 java.lang.String getData()
          Data 'could' store a key to a language file, in order to support multi-language titles
 java.lang.String getFullTitle()
          Called in order to set / update the title of this View.
 java.lang.String getShortTitle()
          Called in order to set / update the short title of this view.
 void initialize(org.eclipse.swt.widgets.Composite composite)
          This method is called when the view is instanciated, it should initialize all GUI components.
 void updateLanguage()
          Called when the language needs updating
 
Methods inherited from interface org.gudy.azureus2.ui.swt.IconBarEnabler
isEnabled, isSelected, itemActivated
 
Methods inherited from interface org.gudy.azureus2.ui.swt.mainwindow.Refreshable
refresh
 

Method Detail

initialize

void initialize(org.eclipse.swt.widgets.Composite composite)
This method is called when the view is instanciated, it should initialize all GUI components. Must NOT be blocking, or it'll freeze the whole GUI. Caller is the GUI Thread.

Parameters:
composite - the parent composite. Each view should create a child composite, and then use this child composite to add all elements to.

getComposite

org.eclipse.swt.widgets.Composite getComposite()
This method is called after initialize so that the Tab is set its control Caller is the GUI Thread.

Returns:
the Composite that should be set as the control for the Tab item

delete

void delete()
This method is caled when the view is destroyed. Each color instanciated, images and such things should be disposed. The caller is the GUI thread.


getData

java.lang.String getData()
Data 'could' store a key to a language file, in order to support multi-language titles

Returns:
a String which is the key of this view title.

getShortTitle

java.lang.String getShortTitle()
Called in order to set / update the short title of this view. When the view is being displayed in a tab, the short title is used for the tab's text

Returns:
A short title for the view

getFullTitle

java.lang.String getFullTitle()
Called in order to set / update the title of this View. When the view is being displayed in a tab, the full title is used for the tooltip.

Returns:
the full title for the view

updateLanguage

void updateLanguage()
Called when the language needs updating


generateDiagnostics

void generateDiagnostics(org.gudy.azureus2.core3.util.IndentWriter writer)
Called when Azureus generates Diagnostics. Write any diagnostic information you want to the writer.

Parameters:
writer -
Since:
2.3.0.4

dataSourceChanged

void dataSourceChanged(java.lang.Object newDataSource)
Called when the selected dataSource has changed. If this view is dependent upon a selected datasource, implement this function and update your view.

Parameters:
newDataSource - null if no datasource is selected. May be an array of Object[] if multiple dataSources are selected
Since:
2.3.0.7