Class UISWTViewBuilderCore

java.lang.Object

com.biglybt.ui.swt.pifimpl.UISWTViewBuilderCore

All Implemented Interfaces:

UISWTViewBuilder

public class UISWTViewBuilderCore
extends Object
implements UISWTViewBuilder

Holds information to create a real UISWTViewEventListener.

Also holds things like PluginInterface reference, initial datasource, title, id.

Nested Class Summary

Nested classes/interfaces inherited from interface UISWTViewBuilder

UISWTViewBuilder.UISWTViewEventListenerInstantiator

Field Summary

Fields

Modifier and Type	Field	Description
private Reference<Class<? extends UISWTViewEventListener>>	cla_ref
private Object	datasource
private boolean	defaultVisibility
private String	initialTitle
private UISWTViewEventListener	listener
private UISWTViewBuilder.UISWTViewEventListenerInstantiator	listenerInstantiator
private final Map<UISWTView, Reference<UISWTViewEventListener>>	mapViewToListener
private String	parentEntryID
private Reference<PluginInterface>	pi_ref
private String	preferredAfterID
private final String	viewID
private String	viewSubID

Constructor Summary

Constructors

Constructor	Description
UISWTViewBuilderCore(String viewID, PluginInterface pi)
UISWTViewBuilderCore(String viewID, PluginInterface pi, UISWTViewEventListener listener)	Deprecated. Use invalid reference UISWTViewBuilder#setListenerInstantiator(boolean, UISWTViewEventListenerInstantiator)
UISWTViewBuilderCore(String viewID, PluginInterface pi, Class<? extends UISWTViewEventListener> cla)	Convenience constructor for creating a builder with a simple class.

Method Summary

Modifier and Type	Method	Description
UISWTViewBuilderCore	cloneBuilder()
UISWTViewEventListener	createEventListener(UISWTView view)
void	dispose()	Closes all views.
void	disposeViews()
boolean	getDefaultVisibility()
Object	getInitialDataSource()
String	getInitialTitle()
UISWTViewEventListener	getListener()
Class<? extends UISWTViewEventListener>	getListenerClass()
UISWTViewBuilder.UISWTViewEventListenerInstantiator	getListenerInstantiator()
String	getParentEntryID()
PluginInterface	getPluginInterface()
String	getPreferredAfterID()
String	getViewID()
String	getViewSubID()
boolean	isListenerCloneable()	Can we create multiple views using this builder?
boolean	isListenerOfClass(Class ofClass)
void	setDefaultVisibility(boolean b)
UISWTViewBuilderCore	setInitialDatasource(Object datasource)	Set the very first datasource the view sees.
UISWTViewBuilderCore	setInitialTitle(String initialTitle)	Sometimes the title is needed even before an instance is created.
UISWTViewBuilderCore	setListenerClass(Class<? extends UISWTViewEventListener> cla)	Sets a UISWTViewEventListener class that will be created when the UI shows the view.
UISWTViewBuilderCore	setListenerInstantiator(UISWTViewBuilder.UISWTViewEventListenerInstantiator listenerInstantiator)	Advanced creation of a UISWTViewEventListener.
UISWTViewBuilderCore	setParentEntryID(String parentEntryID)	Place this entry under the parentEntryID, if UI supports it. Sidebar can have multiple levels of views, but Tabbed MDI places all views at the same level.
UISWTViewBuilderCore	setPreferredAfterID(String preferredAfterID)
void	setViewSubID(String sid)
String	toDebugString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

listener

private UISWTViewEventListener listener

mapViewToListener

private final Map<UISWTView, Reference<UISWTViewEventListener>> mapViewToListener

pi_ref

private Reference<PluginInterface> pi_ref

datasource

private Object datasource

viewID

private final String viewID

viewSubID

private String viewSubID

cla_ref

private Reference<Class<? extends UISWTViewEventListener>> cla_ref

initialTitle

private String initialTitle

preferredAfterID

private String preferredAfterID

listenerInstantiator

private UISWTViewBuilder.UISWTViewEventListenerInstantiator listenerInstantiator

parentEntryID

private String parentEntryID

defaultVisibility

private boolean defaultVisibility

Constructor Details

UISWTViewBuilderCore

public UISWTViewBuilderCore(String viewID,
 PluginInterface pi)

UISWTViewBuilderCore

public UISWTViewBuilderCore(String viewID,
 PluginInterface pi,
 Class<? extends UISWTViewEventListener> cla)

Convenience constructor for creating a builder with a simple class.
Same as UISWTViewBuilderCore(String, PluginInterface).setListenerClass(Class)

UISWTViewBuilderCore

public UISWTViewBuilderCore(String viewID,
 PluginInterface pi,
 UISWTViewEventListener listener)

Deprecated.

Use

invalid reference

UISWTViewBuilder#setListenerInstantiator(boolean, UISWTViewEventListenerInstantiator)

Method Details

cloneBuilder

public UISWTViewBuilderCore cloneBuilder()

isListenerOfClass

public boolean isListenerOfClass(Class ofClass)

getPluginInterface

public PluginInterface getPluginInterface()

setViewSubID

public void setViewSubID(String sid)

Specified by:

setViewSubID in interface UISWTViewBuilder

getViewSubID

public String getViewSubID()

getInitialDataSource

public Object getInitialDataSource()

setInitialDatasource

public UISWTViewBuilderCore setInitialDatasource(Object datasource)

Description copied from interface: UISWTViewBuilder

Set the very first datasource the view sees. Views can retrieve this first datasource even after the datasource changes using UISWTView.getInitialDataSource()

Specified by:

setInitialDatasource in interface UISWTViewBuilder

createEventListener

public UISWTViewEventListener createEventListener(UISWTView view)

getViewID

public String getViewID()

getListener

public UISWTViewEventListener getListener()

dispose

public void dispose()

Closes all views. Clears listener and datasource

disposeViews

public void disposeViews()

getListenerClass

public Class<? extends UISWTViewEventListener> getListenerClass()

setListenerClass

public UISWTViewBuilderCore setListenerClass(Class<? extends UISWTViewEventListener> cla)

Description copied from interface: UISWTViewBuilder

Sets a UISWTViewEventListener class that will be created when the UI shows the view.
Since this class will be instantiated with cla.newInstance(), the class must be a top-level class, and not a local or non-static nested class.

Specified by:

setListenerClass in interface UISWTViewBuilder

getInitialTitle

public String getInitialTitle()

setInitialTitle

public UISWTViewBuilderCore setInitialTitle(String initialTitle)

Description copied from interface: UISWTViewBuilder

Sometimes the title is needed even before an instance is created. For example, menu items that open views

Specified by:

setInitialTitle in interface UISWTViewBuilder

setListenerInstantiator

public UISWTViewBuilderCore setListenerInstantiator(UISWTViewBuilder.UISWTViewEventListenerInstantiator listenerInstantiator)

Description copied from interface: UISWTViewBuilder

Advanced creation of a UISWTViewEventListener. Try not to use :)

Specified by:

setListenerInstantiator in interface UISWTViewBuilder

Parameters:

listenerInstantiator - called when a new UISWTView is created

getListenerInstantiator

public UISWTViewBuilder.UISWTViewEventListenerInstantiator getListenerInstantiator()

Specified by:

getListenerInstantiator in interface UISWTViewBuilder

setPreferredAfterID

public UISWTViewBuilderCore setPreferredAfterID(String preferredAfterID)

Parameters:

preferredAfterID - If you prefix the 'preferedAfterID' string with '~' then the operation will actually switch to 'preferedBeforeID'

Returns:

getPreferredAfterID

public String getPreferredAfterID()

getParentEntryID

public String getParentEntryID()

setParentEntryID

public UISWTViewBuilderCore setParentEntryID(String parentEntryID)

Description copied from interface: UISWTViewBuilder

Place this entry under the parentEntryID, if UI supports it.
Sidebar can have multiple levels of views, but Tabbed MDI places all views at the same level.

Specified by:

setParentEntryID in interface UISWTViewBuilder

getDefaultVisibility

public boolean getDefaultVisibility()

setDefaultVisibility

public void setDefaultVisibility(boolean b)

isListenerCloneable

public boolean isListenerCloneable()

Can we create multiple views using this builder?

toDebugString

public String toDebugString()