Class SideBar

java.lang.Object

com.biglybt.ui.swt.skin.SWTSkinObjectAdapter

com.biglybt.ui.swt.views.skin.SkinView

com.biglybt.ui.swt.mdi.BaseMDI

com.biglybt.ui.swt.views.skin.sidebar.SideBar

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator, UIUpdatable, MultipleDocumentInterface, ObfuscateImage, MultipleDocumentInterfaceSWT, SWTSkinObjectListener

public class SideBar
extends BaseMDI
implements ObfuscateImage, AEDiagnosticsEvidenceGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private SideBarEntrySWT	activeMenuEntry
private int	activity_count
private TimerEventPeriodic	attention_event
private List<SideBarEntrySWT>	attention_seekers
private org.eclipse.swt.graphics.Color	bg
private SWTSkinButtonUtility	btnCloseItem
private ParameterListener	configBGColorListener
private ParameterListener	configRedrawListener
private ParameterListener	configShowSideBarListener
private org.eclipse.swt.widgets.Composite	cPluginsArea
protected SideBarEntrySWT	draggingOver
private org.eclipse.swt.events.SelectionListener	dropDownSelectionListener
private org.eclipse.swt.dnd.DropTarget	dropTarget
protected static final boolean	END_INDENT
private final Stack<String>	entryViewFuture
private final Stack<String>	entryViewHistory
private org.eclipse.swt.graphics.Color	fg
private org.eclipse.swt.graphics.Font	fontHeader
private static final int	GAP_BETWEEN_LEVEL_1
private List<Runnable>	idle_pending
private SideBarEntrySWT	lastMenuEntry
protected SideBarEntrySWT	mousingOver
private Utils.SashWrapper	pluginSash
private final List<UISWTViewImpl>	pluginViews
protected static final int	SIDEBAR_ATTENTION_DURATION
protected static final int	SIDEBAR_ATTENTION_PERIOD
private SWTSkin	skin
private SWTSkinObjectContainer	soSideBarContents
private SWTSkinObject	soSideBarPopout
private UISWTInstanceImpl.SWTViewListener	swtViewListener
private org.eclipse.swt.widgets.Tree	tree
protected static final boolean	USE_NATIVE_EXPANDER
private static final boolean	USE_PAINT

Fields inherited from class BaseMDI

AUTOOPENINFO_DS, AUTOOPENINFO_PARENTID, AUTOOPENINFO_TITLE, CLOSEABLECONFIG_INITIALID

Fields inherited from class SkinView

soMain

Fields inherited from interface MultipleDocumentInterface

SIDEBAR_HEADER_DASHBOARD, SIDEBAR_HEADER_DEVICES, SIDEBAR_HEADER_DISCOVERY, SIDEBAR_HEADER_ORDER_DEFAULT, SIDEBAR_HEADER_PLUGINS, SIDEBAR_HEADER_TRANSFERS, SIDEBAR_HEADER_VUZE, SIDEBAR_POS_FIRST, SIDEBAR_SECTION_ACTIVITIES, SIDEBAR_SECTION_ALL_TRACKERS, SIDEBAR_SECTION_ALLBLOCKS, SIDEBAR_SECTION_ALLPEERS, SIDEBAR_SECTION_ALLPIECES, SIDEBAR_SECTION_ARCHIVED_DOWNLOADS, SIDEBAR_SECTION_BETAPROGRAM, SIDEBAR_SECTION_CHAT, SIDEBAR_SECTION_CLIENT_STATS, SIDEBAR_SECTION_CONFIG, SIDEBAR_SECTION_DEVICES, SIDEBAR_SECTION_DISK_OPS, SIDEBAR_SECTION_DOWNLOAD_HISTORY, SIDEBAR_SECTION_LIBRARY, SIDEBAR_SECTION_LIBRARY_CAT_INSTANCES, SIDEBAR_SECTION_LIBRARY_CD, SIDEBAR_SECTION_LIBRARY_DL, SIDEBAR_SECTION_LIBRARY_TAG_INSTANCES, SIDEBAR_SECTION_LIBRARY_UNOPENED, SIDEBAR_SECTION_LOGGER, SIDEBAR_SECTION_MY_SHARES, SIDEBAR_SECTION_MY_TRACKER, SIDEBAR_SECTION_PLUGINS, SIDEBAR_SECTION_SEARCH, SIDEBAR_SECTION_SUBSCRIPTIONS, SIDEBAR_SECTION_TAG_DISCOVERY, SIDEBAR_SECTION_TAGS, SIDEBAR_SECTION_TORRENT_DETAILS, SIDEBAR_SECTION_TORRENT_OPTIONS, SIDEBAR_SECTION_WELCOME, SIDEBAR_TRANSFERS_SECTION_ORDER

Fields inherited from interface SWTSkinObjectListener

EVENT_CREATE_REQUEST, EVENT_CREATED, EVENT_DATASOURCE_CHANGED, EVENT_DESTROY, EVENT_HIDE, EVENT_LANGUAGE_CHANGE, EVENT_OBFUSCATE, EVENT_SELECT, EVENT_SHOW, NAMES

Constructor Summary

Constructors

Constructor	Description
SideBar()

Method Summary

Modifier and Type	Method	Description
private void	_setupNewEntry(SideBarEntrySWT entry, String id, boolean expandParent, boolean closeable)
private void	activityEnd()
private void	activityStart()
private void	addGeneralMenus()
private void	addHistory(MdiEntry entry)
void	addItem(BaseMdiEntry entry)
private void	addSideBarView(UISWTViewImpl view, org.eclipse.swt.widgets.Composite cPluginsArea)
void	buildMDI(SWTSkinObject skinObject)
void	buildMDI(org.eclipse.swt.widgets.Composite parent)	Builds MDI and populates it with entries registered to id or datasourcetype
boolean	canPopoutEntry(MdiEntry entry)
BaseMdiEntry	closeEntryByID(String id, boolean user_initiated)
SideBarEntrySWT	createEntry(UISWTViewBuilderCore builder, boolean closeable)
protected SideBarEntrySWT	createEntryByCreationListener(String id, Map<?,?> autoOpenInfo)
SideBarEntrySWT	createEntryFromSkinRef(String parentEntryID, String id, String configID, String title, ViewTitleInfo titleInfo, Object params, boolean closeable, String preferredAfterID)	If you prefix the 'preferedAfterID' string with '~' then the operation will actually switch to 'preferedBeforeID'
SideBarEntrySWT	createHeader(String id, String titleID, String preferredAfterID)
private void	createSideBar()
private void	createSideBarPluginViews()
private org.eclipse.swt.widgets.TreeItem	createTreeItem(SideBarEntrySWT entry, org.eclipse.swt.widgets.TreeItem parentSwtItem, int index)
protected void	defaultDrop(org.eclipse.swt.dnd.DropTargetEvent event)
protected boolean	fillDropDownMenu(org.eclipse.swt.widgets.Menu menuDropDown, org.eclipse.swt.widgets.TreeItem[] items, int indent)
void	flipSideBarVisibility()
void	generate(IndentWriter writer)
protected org.eclipse.swt.graphics.Color	getBackground()
SideBarEntrySWT	getEntry(String id)
SideBarEntrySWT	getEntryBySkinView(Object skinView)
org.eclipse.swt.graphics.Font	getHeaderFont()
SideBarEntrySWT	getMenuEntry(boolean activeOnly)
SideBarEntrySWT	getSelectedEntry()
protected String	getShowIDAtStartup()
protected org.eclipse.swt.widgets.Tree	getTree()
private org.eclipse.swt.widgets.TreeItem	getTreeItemAt(int pos)
private org.eclipse.swt.widgets.TreeItem	getTreeItemAt(org.eclipse.swt.widgets.TreeItem[] items, int[] pos)
protected int	indexOf(MdiEntry entry)
boolean	isVisible()
protected void	itemSelected(MdiEntry entry)
org.eclipse.swt.graphics.Image	obfuscatedImage(org.eclipse.swt.graphics.Image image)
boolean	popoutEntry(MdiEntry entry, Map<String,Object> options)
private void	removeSideBarView(UISWTViewImpl view)
protected void	requestAttention(SideBarEntrySWT entry)
void	runWhenIdle(Runnable r)
protected void	setBackground(SWTSkinProperties sp)
protected void	setEntryLoadedOnce(String id)
private void	setMenuEntry(SideBarEntrySWT me)
protected void	setSelectedEntry(MdiEntrySWT entry)
private void	setupNewEntry(SideBarEntrySWT entry, String id, boolean expandParent, boolean closeable)
protected void	setupPluginViews()
void	showEntry(MdiEntry newEntry)
private void	showNext()
private void	showPrevious()
Object	skinObjectCreated(SWTSkinObject skinObject, Object params)	Skin Object was created.
Object	skinObjectDestroyed(SWTSkinObject skinObject, Object params)	Skin Object was destroyed
Object	skinObjectInitialShow(SWTSkinObject skinObject, Object params)
private void	swt_redraw()
private void	swt_redraw(org.eclipse.swt.widgets.TreeItem[] items)
private void	swt_updateSideBarColors()
private void	swt_updateSideBarColors(org.eclipse.swt.widgets.TreeItem[] items)
private void	swt_updateSideBarHitAreasY(SideBarEntrySWT[] entries)
private void	updateSidebarVisibility()
void	updateUI()	Update your UI!
protected boolean	wasEntryLoadedOnce(String id)

Methods inherited from class BaseMDI

addListener, addListener, addListener, canShowEntryByID, closeEntry, closeEntry, closeEntryByID, createEntryFromEventListener, deregisterEntry, deregisterEntry, entryExists, fillMenu, getChildrenOf, getDataSourceType, getEntries, getEntries, getEntriesCount, getEntry, getEntryFromSkinObject, getMenuHackListeners, getMenuIdPrefix, getParentView, getPreferredOrder, getUpdateUIName, getViewID, isInitialized, loadEntryByID, loadEntryByID, popoutEntryByID, registerEntry, registerEntry, removeEntryAutoOpen, removeItem, removeItem, removeListener, removeListener, removeListener, saveCloseables, setCloseableConfigFile, setDefaultEntryID, setEntryAutoOpen, setPreferredOrder, showEntryByID, showEntryByID, triggerEntryLoadedListeners, triggerSelectionListener, updateLanguage, willEntryAutoOpen

Methods inherited from class SkinView

getMainSkinObject, getMdiEntry, getSkin, getSkinObject, isDisposed, setMainSkinObject, skinObjectHidden, skinObjectShown

Methods inherited from class SWTSkinObjectAdapter

dataSourceChanged, eventOccured, skinObjectSelected

Methods inherited from class Object

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

Methods inherited from interface MultipleDocumentInterface

isDisposed

Field Details

END_INDENT

protected static final boolean END_INDENT

USE_PAINT

private static final boolean USE_PAINT

USE_NATIVE_EXPANDER

protected static final boolean USE_NATIVE_EXPANDER

GAP_BETWEEN_LEVEL_1

private static final int GAP_BETWEEN_LEVEL_1

SIDEBAR_ATTENTION_PERIOD

protected static final int SIDEBAR_ATTENTION_PERIOD

See Also:

• Constant Field Values

SIDEBAR_ATTENTION_DURATION

protected static final int SIDEBAR_ATTENTION_DURATION

See Also:

• Constant Field Values

skin

private SWTSkin skin

soSideBarContents

private SWTSkinObjectContainer soSideBarContents

tree

private org.eclipse.swt.widgets.Tree tree

fontHeader

private org.eclipse.swt.graphics.Font fontHeader

soSideBarPopout

private SWTSkinObject soSideBarPopout

btnCloseItem

private SWTSkinButtonUtility btnCloseItem

dropDownSelectionListener

private org.eclipse.swt.events.SelectionListener dropDownSelectionListener

dropTarget

private org.eclipse.swt.dnd.DropTarget dropTarget

draggingOver

protected SideBarEntrySWT draggingOver

mousingOver

protected SideBarEntrySWT mousingOver

fg

private org.eclipse.swt.graphics.Color fg

bg

private org.eclipse.swt.graphics.Color bg

attention_seekers

private List<SideBarEntrySWT> attention_seekers

attention_event

private TimerEventPeriodic attention_event

cPluginsArea

private org.eclipse.swt.widgets.Composite cPluginsArea

pluginSash

private Utils.SashWrapper pluginSash

pluginViews

private final List<UISWTViewImpl> pluginViews

configShowSideBarListener

private ParameterListener configShowSideBarListener

configRedrawListener

private ParameterListener configRedrawListener

configBGColorListener

private ParameterListener configBGColorListener

swtViewListener

private UISWTInstanceImpl.SWTViewListener swtViewListener

activeMenuEntry

private SideBarEntrySWT activeMenuEntry

lastMenuEntry

private SideBarEntrySWT lastMenuEntry

entryViewHistory

private final Stack<String> entryViewHistory

entryViewFuture

private final Stack<String> entryViewFuture

idle_pending

private List<Runnable> idle_pending

activity_count

private int activity_count

Constructor Details

SideBar

public SideBar()

Method Details

buildMDI

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

Description copied from interface: MultipleDocumentInterfaceSWT

Builds MDI and populates it with entries registered to id or datasourcetype

Specified by:

buildMDI in interface MultipleDocumentInterfaceSWT

Parameters:

parent -

buildMDI

public void buildMDI(SWTSkinObject skinObject)

Specified by:

buildMDI in interface MultipleDocumentInterfaceSWT

skinObjectCreated

public Object skinObjectCreated(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

Skin Object was created. All children are guaranteed to be created.

Overrides:

skinObjectCreated in class SkinView

addGeneralMenus

private void addGeneralMenus()

Since:

3.1.0.1

getShowIDAtStartup

protected String getShowIDAtStartup()

Overrides:

getShowIDAtStartup in class BaseMDI

canPopoutEntry

public boolean canPopoutEntry(MdiEntry entry)

popoutEntry

public boolean popoutEntry(MdiEntry entry,
 Map<String,Object> options)

Specified by:

popoutEntry in class BaseMDI

flipSideBarVisibility

public void flipSideBarVisibility()

Since:

3.1.1.1

updateSidebarVisibility

private void updateSidebarVisibility()

isVisible

public boolean isVisible()

Specified by:

isVisible in interface MultipleDocumentInterface

Overrides:

isVisible in class SkinView

Returns:

the visible

skinObjectInitialShow

public Object skinObjectInitialShow(SWTSkinObject skinObject,
 Object params)

Overrides:

skinObjectInitialShow in class BaseMDI

Parameters:

skinObject -

params -

Returns:

setupPluginViews

protected void setupPluginViews()

Overrides:

setupPluginViews in class BaseMDI

skinObjectDestroyed

public Object skinObjectDestroyed(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

Skin Object was destroyed

Overrides:

skinObjectDestroyed in class BaseMDI

setBackground

protected void setBackground(SWTSkinProperties sp)

getBackground

protected org.eclipse.swt.graphics.Color getBackground()

createSideBar

private void createSideBar()

createSideBarPluginViews

private void createSideBarPluginViews()

addSideBarView

private void addSideBarView(UISWTViewImpl view,
 org.eclipse.swt.widgets.Composite cPluginsArea)

removeSideBarView

private void removeSideBarView(UISWTViewImpl view)

defaultDrop

protected void defaultDrop(org.eclipse.swt.dnd.DropTargetEvent event)

Parameters:

event -

fillDropDownMenu

protected boolean fillDropDownMenu(org.eclipse.swt.widgets.Menu menuDropDown,
 org.eclipse.swt.widgets.TreeItem[] items,
 int indent)

Parameters:

menuDropDown -

Since:

3.1.1.1

swt_updateSideBarHitAreasY

private void swt_updateSideBarHitAreasY(SideBarEntrySWT[] entries)

Since:

3.1.1.1

swt_updateSideBarColors

private void swt_updateSideBarColors()

swt_updateSideBarColors

private void swt_updateSideBarColors(org.eclipse.swt.widgets.TreeItem[] items)

swt_redraw

private void swt_redraw()

swt_redraw

private void swt_redraw(org.eclipse.swt.widgets.TreeItem[] items)

indexOf

protected int indexOf(MdiEntry entry)

createHeader

public SideBarEntrySWT createHeader(String id,
 String titleID,
 String preferredAfterID)

Specified by:

createHeader in interface MultipleDocumentInterface

setupNewEntry

private void setupNewEntry(SideBarEntrySWT entry,
 String id,
 boolean expandParent,
 boolean closeable)

_setupNewEntry

private void _setupNewEntry(SideBarEntrySWT entry,
 String id,
 boolean expandParent,
 boolean closeable)

createTreeItem

private org.eclipse.swt.widgets.TreeItem createTreeItem(SideBarEntrySWT entry,
 org.eclipse.swt.widgets.TreeItem parentSwtItem,
 int index)

setSelectedEntry

protected void setSelectedEntry(MdiEntrySWT entry)

Overrides:

setSelectedEntry in class BaseMDI

showEntry

public void showEntry(MdiEntry newEntry)

Specified by:

showEntry in interface MultipleDocumentInterface

createEntry

public SideBarEntrySWT createEntry(UISWTViewBuilderCore builder,
 boolean closeable)

Specified by:

createEntry in interface MultipleDocumentInterfaceSWT

Returns:

Newly created MDI Entry

createEntryFromSkinRef

public SideBarEntrySWT createEntryFromSkinRef(String parentEntryID,
 String id,
 String configID,
 String title,
 ViewTitleInfo titleInfo,
 Object params,
 boolean closeable,
 String preferredAfterID)

Description copied from interface: MultipleDocumentInterface

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

Specified by:

createEntryFromSkinRef in interface MultipleDocumentInterface

Specified by:

createEntryFromSkinRef in class BaseMDI

Parameters:

parentEntryID -

id -

configID -

title -

titleInfo -

params -

closeable -

preferredAfterID -

Returns:

updateUI

public void updateUI()

Description copied from interface: UIUpdatable

Update your UI!

Specified by:

updateUI in interface UIUpdatable

Overrides:

updateUI in class BaseMDI

wasEntryLoadedOnce

protected boolean wasEntryLoadedOnce(String id)

Specified by:

wasEntryLoadedOnce in class BaseMDI

setEntryLoadedOnce

protected void setEntryLoadedOnce(String id)

Specified by:

setEntryLoadedOnce in class BaseMDI

getHeaderFont

public org.eclipse.swt.graphics.Font getHeaderFont()

getTree

protected org.eclipse.swt.widgets.Tree getTree()

requestAttention

protected void requestAttention(SideBarEntrySWT entry)

getTreeItemAt

private org.eclipse.swt.widgets.TreeItem getTreeItemAt(int pos)

getTreeItemAt

private org.eclipse.swt.widgets.TreeItem getTreeItemAt(org.eclipse.swt.widgets.TreeItem[] items,
 int[] pos)

addItem

public void addItem(BaseMdiEntry entry)

Overrides:

addItem in class BaseMDI

itemSelected

protected void itemSelected(MdiEntry entry)

Overrides:

itemSelected in class BaseMDI

closeEntryByID

public BaseMdiEntry closeEntryByID(String id,
 boolean user_initiated)

Overrides:

closeEntryByID in class BaseMDI

addHistory

private void addHistory(MdiEntry entry)

showNext

private void showNext()

showPrevious

private void showPrevious()

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator

obfuscatedImage

public org.eclipse.swt.graphics.Image obfuscatedImage(org.eclipse.swt.graphics.Image image)

Specified by:

obfuscatedImage in interface ObfuscateImage

getEntry

public SideBarEntrySWT getEntry(String id)

Specified by:

getEntry in interface MultipleDocumentInterface

Specified by:

getEntry in interface MultipleDocumentInterfaceSWT

Overrides:

getEntry in class BaseMDI

getSelectedEntry

public SideBarEntrySWT getSelectedEntry()

Specified by:

getSelectedEntry in interface MultipleDocumentInterface

Specified by:

getSelectedEntry in interface MultipleDocumentInterfaceSWT

Overrides:

getSelectedEntry in class BaseMDI

setMenuEntry

private void setMenuEntry(SideBarEntrySWT me)

getMenuEntry

public SideBarEntrySWT getMenuEntry(boolean activeOnly)

Specified by:

getMenuEntry in interface MultipleDocumentInterface

getEntryBySkinView

public SideBarEntrySWT getEntryBySkinView(Object skinView)

Specified by:

getEntryBySkinView in interface MultipleDocumentInterfaceSWT

Overrides:

getEntryBySkinView in class BaseMDI

Parameters:

skinView -

Returns:

createEntryByCreationListener

protected SideBarEntrySWT createEntryByCreationListener(String id,
 Map<?,?> autoOpenInfo)

Overrides:

createEntryByCreationListener in class BaseMDI

activityStart

private void activityStart()

activityEnd

private void activityEnd()

runWhenIdle

public void runWhenIdle(Runnable r)

Specified by:

runWhenIdle in interface MultipleDocumentInterface