au.com.cybersearch2.statusbar

Class StatusItem

java.lang.Object

au.com.cybersearch2.statusbar.StatusItem

public class StatusItem
extends Object

StatusItem Configures and controls one status line item, the content of which is rendered using a CLabel widget. The item can be hidden by calling hide() and unhidden using show(). The item can also be hidden by setting both image and text to null. If the item displays text, then it is recommended to set the width hint to allow for the widest string so that the item width stays constant. However, the CLabel control will elide text when there is insuffient space to show the entire string and will place the text in a tooltip, if one has been provided.

Author:

Andrew Bowley 26 Jun 2016

See Also:

CLabel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelItem.Field

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.graphics.Color	bgColor
protected org.eclipse.swt.graphics.Font	font
protected int	id Unique identity
protected org.eclipse.swt.graphics.Image	image
protected boolean	isVisible Visibility flag
protected String	text
protected String	tooltip
protected int	width

Constructor Summary

Constructors

Constructor and Description
StatusItem(au.com.cybersearch2.controls.CustomLabelSpec itemConfiguration, int id) Create StatusItem object

Method Summary

Modifier and Type	Method and Description
int	getId() Returns identity
org.eclipse.swt.graphics.Image	getImage()
org.eclipse.swt.widgets.Menu	getMenu()
String	getText()
String	getTooltip()
protected boolean	getVisibility() Returns visibility status
int	getWidth()
void	hide() Hide this item.
boolean	isVisible()
org.eclipse.swt.custom.CLabel	labelInstance(au.com.cybersearch2.controls.ControlFactory controlFactory, org.eclipse.swt.widgets.Composite parent) Return custom label initialized with values contained in this item
protected void	setConfiguration(au.com.cybersearch2.controls.CustomLabelSpec itemConfiguration) Set fields from given specification
void	setEventListener(int eventType, org.eclipse.swt.widgets.Listener listener) Add listener
void	setImage(org.eclipse.swt.graphics.Image image) Set image
void	setLabel(String text, org.eclipse.swt.graphics.Image image) Set both text and image
void	setLabelItemListener(StatusItemListener statusItemListener) Set listener to be called when this object is updated
void	setLabelListener(LabelListener labelListener)
void	setMenu(org.eclipse.swt.widgets.Menu menu) Set context menu, which will pop up when the item is right clicked
void	setText(String text) Set the text
void	setTooltip(String tooltip) Set tooltip
void	setWidth(int width) Set width hint
void	show() Show this item.
protected void	signalRedraw() Redraw entire status line
protected void	signalUpdate(LabelItem.Field[] updateFields) Update label only
void	update(au.com.cybersearch2.controls.CustomLabelSpec updateSpec) Update this object using given specification
protected boolean	updateVisible(boolean isVisible) Update isVisible flag if different from given value.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

Unique identity

isVisible

protected boolean isVisible

Visibility flag

image

protected org.eclipse.swt.graphics.Image image

text

protected String text

width

protected int width

font

protected org.eclipse.swt.graphics.Font font

bgColor

protected org.eclipse.swt.graphics.Color bgColor

tooltip

protected String tooltip

Constructor Detail

StatusItem

public StatusItem(au.com.cybersearch2.controls.CustomLabelSpec itemConfiguration,
                  int id)

Create StatusItem object

Parameters:

itemConfiguration - Custom label data including width in number of characters

id - Unique identity with range starting from 0

Method Detail

getId

public int getId()

Returns identity

Returns:

int value

See Also:

LabelItem.getId()

getImage

public org.eclipse.swt.graphics.Image getImage()

Returns:

the image

See Also:

LabelItem.getImage()

getText

public String getText()

Returns:

the text

See Also:

LabelItem.getText()

getWidth

public int getWidth()

Returns:

the width hint in number of characters

See Also:

LabelItem.getWidth()

isVisible

public boolean isVisible()

Returns:

isVisible flag

See Also:

LabelItem.isVisible()

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

Set image

Parameters:

image - Image object

See Also:

LabelItem.setImage(org.eclipse.swt.graphics.Image)

setText

public void setText(String text)

Set the text

Parameters:

text - String

See Also:

LabelItem.setText(java.lang.String)

setWidth

public void setWidth(int width)

Set width hint

Parameters:

width - Width in number of characters

See Also:

LabelItem.setWidth(int)

setLabel

public void setLabel(String text,
                     org.eclipse.swt.graphics.Image image)

Set both text and image

image - Image object

See Also:

LabelItem.setLabel(java.lang.String, org.eclipse.swt.graphics.Image)

hide

public void hide()

Hide this item. Does not change text or image attributes.

show

public void show()

Show this item. Note that if there is no image or text configured, the item will be blank and 6 pixels wide.

update

public void update(au.com.cybersearch2.controls.CustomLabelSpec updateSpec)

Update this object using given specification

See Also:

au.com.cybersearch2.statusbar.LabelItem#update(au.com.cybersearch2.statusbar.controls.ItemConfiguration)

setLabelItemListener

public void setLabelItemListener(StatusItemListener statusItemListener)

Set listener to be called when this object is updated

See Also:

LabelItem.setLabelItemListener(au.com.cybersearch2.statusbar.StatusItemListener)

setEventListener

public void setEventListener(int eventType,
                             org.eclipse.swt.widgets.Listener listener)

Add listener

Parameters:

eventType - Listener event type

listener - Listener object

setLabelListener

public void setLabelListener(LabelListener labelListener)

setTooltip

public void setTooltip(String tooltip)

Set tooltip

Parameters:

tooltip - Text to appear on mouse over item - null or empty String disables feature

See Also:

LabelItem.setTooltip(java.lang.String)

getTooltip

public String getTooltip()

Returns:

the tooltep

See Also:

LabelItem.getTooltip()

setMenu

public void setMenu(org.eclipse.swt.widgets.Menu menu)

Set context menu, which will pop up when the item is right clicked

Parameters:

menu - Menu object

See Also:

LabelItem.setMenu(org.eclipse.swt.widgets.Menu)

getMenu

public org.eclipse.swt.widgets.Menu getMenu()

Returns:

the context memu or null if none

See Also:

LabelItem.getMenu()

labelInstance

public org.eclipse.swt.custom.CLabel labelInstance(au.com.cybersearch2.controls.ControlFactory controlFactory,
                                                   org.eclipse.swt.widgets.Composite parent)

Return custom label initialized with values contained in this item

Parameters:

controlFactory - SWT widget factory

parent - Parent composite

Returns:

See Also:

LabelItem.labelInstance(au.com.cybersearch2.controls.ControlFactory, org.eclipse.swt.widgets.Composite)

setConfiguration

protected void setConfiguration(au.com.cybersearch2.controls.CustomLabelSpec itemConfiguration)

Set fields from given specification

Parameters:

itemConfiguration - The specification

updateVisible

protected boolean updateVisible(boolean isVisible)

Update isVisible flag if different from given value. Redraw on change of visibility.

Parameters:

isVisible - boolean

Returns:

flag set true if visibility has changed

getVisibility

protected boolean getVisibility()

Returns visibility status

Returns:

signalRedraw

protected void signalRedraw()

Redraw entire status line

signalUpdate

protected void signalUpdate(LabelItem.Field[] updateFields)

Update label only

Parameters:

updateFields -