TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.uml2sd.ui.preferences
Class SDViewPref

java.lang.Object
  extended by org.eclipse.hyades.uml2sd.ui.preferences.SDViewPref
All Implemented Interfaces:
java.util.EventListener, ISDPreferences, org.eclipse.jface.util.IPropertyChangeListener

public class SDViewPref
extends java.lang.Object
implements ISDPreferences, org.eclipse.jface.util.IPropertyChangeListener

This is the Sequence Diagram preference handler This class is reponsible for accessing the current user preferences selection This class also provider getters for each modifiable preferences


Field Summary
static java.lang.String BACK_COLOR_POSTFIX
           
static java.lang.String[] fontList
           
static java.lang.String[] fontList2
           
static java.lang.String FORE_COLOR_POSTFIX
           
static java.lang.String[] prefBackColorList
           
static java.lang.String[] prefForeColorList
           
static java.lang.String[] prefTextColorList
           
static java.lang.String TEXT_COLOR_POSTFIX
           
 
Fields inherited from interface org.eclipse.hyades.uml2sd.ui.drawings.ISDPreferences
PREF_ASYNC_MESS, PREF_ASYNC_MESS_RET, PREF_EXCLUDE_EXTERNAL_TIME, PREF_EXEC, PREF_FRAME, PREF_FRAME_NAME, PREF_LIFELINE, PREF_LIFELINE_HEADER, PREF_LIFELINE_WIDTH, PREF_LINK_FONT, PREF_SYNC_MESS, PREF_SYNC_MESS_RET, PREF_TIME_COMP, PREF_TOOLTIP, PREF_USE_GRADIENT
 
Method Summary
 void addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
           
 void apply()
          Apply the preferences in the preferences handler
 boolean excludeExternalTime()
          Return true if the user do not want to take external time (basically found and lost messages with time) into account in the min max computation
 boolean fontLinked()
          Returns if font linkage with zoom has been chosen
 IColor getBackGroundColor(java.lang.String prefName)
          Returns the chosen backgrounf color
 IColor getBackGroundColorSelection()
          Returns the background color to use for widget selection.
 IFont getFont(java.lang.String prefName)
          Returns the chosen font
 IColor getFontColor(java.lang.String prefName)
          Returns the chosen font color
 IColor getForeGroundColor(java.lang.String prefName)
          Returns the chosen foreground color
 IColor getForeGroundColorSelection()
          Returns the forground color to use for widget selection.
static SDViewPref getInstance()
          Returns an unique instance of the Sequence Diagram preference handler
 int getLifelineWidth()
          Returns the SwimLane width chosen
 org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
          Returns the PreferenceStore
 IColor getTimeCompressionSelectionColor()
          Returns the color used to connect the time compression bar to the diagram graph node
 void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)
           
 void removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
           
 void setNoFocusSelection(boolean v)
           
 boolean tooltipEnabled()
          Returns the tooltip enablement
 boolean useGradienColor()
          Returns if the use gradient color has been chosen
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BACK_COLOR_POSTFIX

public static final java.lang.String BACK_COLOR_POSTFIX
See Also:
Constant Field Values

FORE_COLOR_POSTFIX

public static final java.lang.String FORE_COLOR_POSTFIX
See Also:
Constant Field Values

TEXT_COLOR_POSTFIX

public static final java.lang.String TEXT_COLOR_POSTFIX
See Also:
Constant Field Values

fontList

public static final java.lang.String[] fontList

fontList2

public static final java.lang.String[] fontList2

prefBackColorList

public static final java.lang.String[] prefBackColorList

prefForeColorList

public static final java.lang.String[] prefForeColorList

prefTextColorList

public static final java.lang.String[] prefTextColorList
Method Detail

getPreferenceStore

public org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
Returns the PreferenceStore

Returns:
the PreferenceStore

apply

public void apply()
Apply the preferences in the preferences handler


getInstance

public static SDViewPref getInstance()
Returns an unique instance of the Sequence Diagram preference handler

Returns:
the preference handler instance

getForeGroundColor

public IColor getForeGroundColor(java.lang.String prefName)
Returns the chosen foreground color

Specified by:
getForeGroundColor in interface ISDPreferences
Returns:
the forgroud color

getBackGroundColor

public IColor getBackGroundColor(java.lang.String prefName)
Returns the chosen backgrounf color

Specified by:
getBackGroundColor in interface ISDPreferences
Parameters:
prefName - the preference nam
Returns:
the background color

getFontColor

public IColor getFontColor(java.lang.String prefName)
Returns the chosen font color

Specified by:
getFontColor in interface ISDPreferences
Returns:
the font color

getForeGroundColorSelection

public IColor getForeGroundColorSelection()
Returns the forground color to use for widget selection. This color is system dependant and not set using the prefrence page

Specified by:
getForeGroundColorSelection in interface ISDPreferences
Returns:
the forground color

getBackGroundColorSelection

public IColor getBackGroundColorSelection()
Returns the background color to use for widget selection. This color is system dependant and not set using the prefrence page

Specified by:
getBackGroundColorSelection in interface ISDPreferences
Returns:
the background color

getFont

public IFont getFont(java.lang.String prefName)
Returns the chosen font

Specified by:
getFont in interface ISDPreferences
Parameters:
prefName - the preference name
Returns:
the font

getLifelineWidth

public int getLifelineWidth()
Returns the SwimLane width chosen

Returns:
the SwimLane width

fontLinked

public boolean fontLinked()
Returns if font linkage with zoom has been chosen

Returns:
true if cheched false otherwise

tooltipEnabled

public boolean tooltipEnabled()
Returns the tooltip enablement

Returns:
true if cheched false otherwise

excludeExternalTime

public boolean excludeExternalTime()
Return true if the user do not want to take external time (basically found and lost messages with time) into account in the min max computation

Returns:
true if cheched false otherwise

useGradienColor

public boolean useGradienColor()
Returns if the use gradient color has been chosen

Specified by:
useGradienColor in interface ISDPreferences
Returns:
true if cheched false otherwise

getTimeCompressionSelectionColor

public IColor getTimeCompressionSelectionColor()
Returns the color used to connect the time compression bar to the diagram graph node

Specified by:
getTimeCompressionSelectionColor in interface ISDPreferences
Returns:
the selection color

addPropertyChangeListener

public void addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)

propertyChange

public void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)
Specified by:
propertyChange in interface org.eclipse.jface.util.IPropertyChangeListener

setNoFocusSelection

public void setNoFocusSelection(boolean v)

TPTP 4.5.0 Platform Project
Public API Specification