org.openflexo.gina.view.impl

Class FIBWidgetViewImpl<M extends FIBWidget,C,T>

java.lang.Object

org.openflexo.gina.view.impl.FIBViewImpl<M,C>

org.openflexo.gina.view.impl.FIBWidgetViewImpl<M,C,T>

Type Parameters:

M - type of FIBWidget this view represents

C - type of technology-specific component this view manage

T - type of data beeing represented by this view

Direct Known Subclasses:

FIBBrowserWidgetImpl, FIBButtonWidgetImpl, FIBCheckBoxWidgetImpl, FIBColorWidgetImpl, FIBCustomWidgetImpl, FIBDateWidgetImpl, FIBEditorWidgetImpl, FIBFileWidgetImpl, FIBFontWidgetImpl, FIBGenericTextWidgetImpl, FIBHtmlEditorWidgetImpl, FIBImageWidgetImpl, FIBLabelWidgetImpl, FIBMultipleValueWidgetImpl, FIBNumberWidgetImpl, FIBReferencedComponentWidgetImpl, FIBTableWidgetImpl

public abstract class FIBWidgetViewImpl<M extends FIBWidget,C,T>
extends FIBViewImpl<M,C>

Abstract class representing a widget view

Author:

sylvain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FIBWidgetViewImpl.DynamicEventListener
protected class	FIBWidgetViewImpl.DynamicFormatter
protected class	FIBWidgetViewImpl.DynamicValueBindingContext
class	FIBWidgetViewImpl.FIBDynamicBindingEvaluationContext

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_hasFocus
static Font	DEFAULT_LABEL_FONT
static Font	DEFAULT_MEDIUM_FONT
static String	ENABLED
protected <any>	GENotifier
static int	META_MASK
static Dimension	MINIMUM_SIZE
protected C	technologyComponent
protected boolean	widgetDisableUserEvent
protected boolean	widgetExecuting

Fields inherited from class org.openflexo.gina.view.impl.FIBViewImpl

BOTTOM_COMPENSATING_BORDER, LEFT_COMPENSATING_BORDER, RIGHT_COMPENSATING_BORDER, TOP_COMPENSATING_BORDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FIBWidgetViewImpl(M model, FIBController aController, <any> RenderingAdapter)

Method Summary

Modifier and Type	Method and Description
void	allowListening()
void	applyDoubleClickAction(FIBMouseEvent event) Called after the platform-specific controller has detected a mouse event matching a double-click action
void	applyRightClickAction(FIBMouseEvent event) Called after the platform-specific controller has detected a mouse event matching a right-click action
void	applySingleClickAction(FIBMouseEvent event) Called after the platform-specific controller has detected a mouse event matching a single-click action
protected void	componentBecomesInvisible() Called when the component view explicitely change its visibility state from VISIBLE to INVISIBLE
protected void	componentBecomesVisible() Called when the component view explicitely change its visibility state from INVISIBLE to VISIBLE
protected void	componentGainsFocus() Called when the component view explicitely changes its focus state from UNFOCUSED to FOCUSED
protected void	componentLoosesFocus() Called when the component view explicitely changes its focus state from FOCUSED to UNFOCUSED
void	delete()
void	executeEvent(EventDescription e)
void	focusGained(FocusEvent event)
void	focusLost(FocusEvent event)
protected void	gainFocus()
T	getDefaultData()
Icon	getIconRepresentation(Object value)
<any>	getNotifier()
T	getRepresentedValue()
String	getStringRepresentation(Object value)
C	getTechnologyComponent() Return technology-specific component representing widget Note that, depending on the underlying technology, this technology-specific component might be embedded in an other component before to be added in component hierarchy (for example if component need to be embedded in a scroll pane)
Object	getTechnologyComponentForFIBComponent(FIBComponent component) Return technology component for supplied FIBComponent Return technology component if supplied FIBComponent is the represented widget itself, otherwise return null
T	getValue() Return the value represented by the widget Note that if value binding has been set for related FIBWidget, return the value computed from the value binding If no value was declared, return the value represented by this FIBWidgetView
M	getWidget()
boolean	hasValue() Return boolean indicating if represented widget defines a value binding (a connection to some data)
protected static int	indexOfFirstCharExceeding(String s, int width, FontMetrics fm)
void	invokeLater(Runnable r, long aggregationTimeOut) Semantics of this method is not trivial: the goal is to aggregate some notifications within a given time (supplied as a aggregationTimeOut), to do it only once. Within this delay, all requests to this method will simply reinitialize time-out, and will be ignored.
boolean	isComponentEnabled()
boolean	isEnabled()
boolean	isFocused()
boolean	isListeningLocked()
boolean	isReadOnly()
boolean	isWidgetEnabled()
void	lockListening()
protected void	looseFocus()
protected abstract C	makeTechnologyComponent() Create technology-specific component representing FIBWidget
protected void	performUpdate() Internally called to update the view, once the visibility has been handled by FIBViewImpl.update() method
protected void	performValueChangedAction()
void	propertyChange(PropertyChangeEvent evt)
void	setEnabled(boolean enabled)
void	setValue(T aValue) Programmatically sets the value represented by the widget
protected static List<String>	trimString(String s, int width, FontMetrics fm)
protected void	updateComponentsExplicitelyDeclaredAsDependant()
T	updateData() This method is called whenever a notification has been raised, changing the value expressed by data binding (the value beeing represented by this widget) This method first compute the value, set the dynamic value stored in this widget with this new value, and then update the widget with the new computed value. This method should be overriden in sub-classes
void	updateEnability() Called when a widget becomes visible There is no guarantee that widget is in sync with the model, so, we need to call updateWidgetFromModel again
void	updateFont()
void	updateLanguage()

Methods inherited from class org.openflexo.gina.view.impl.FIBViewImpl

equals, fireVariableChanged, getBindingEvaluationContext, getComponent, getController, getDataObject, getDeletedProperty, getEmbeddingComponent, getFont, getLocalized, getParentView, getPropertyChangeSupport, getRenderingAdapter, getRuntimeContext, getValue, getVariableValue, hideView, isComponentVisible, isDeleted, isUpdating, isViewVisible, languageChanged, notEquals, requestFocus, requestFocusInParent, requestFocusInWindow, sameCollections, setEmbeddingComponent, setParentView, setRuntimeContext, setValue, setVariableValue, setVisible, showView, update, updateBackgroundColor, updateForegroundColor, updateMaximumSize, updateMinimumSize, updateOpacity, updatePreferredSize, updateVisibility

Methods inherited from class java.lang.Object

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

Field Detail

META_MASK

public static final int META_MASK

ENABLED

public static final String ENABLED

See Also:

Constant Field Values

DEFAULT_LABEL_FONT

public static final Font DEFAULT_LABEL_FONT

DEFAULT_MEDIUM_FONT

public static final Font DEFAULT_MEDIUM_FONT

technologyComponent

protected C technologyComponent

MINIMUM_SIZE

public static final Dimension MINIMUM_SIZE

widgetExecuting

protected boolean widgetExecuting

widgetDisableUserEvent

protected boolean widgetDisableUserEvent

GENotifier

protected <any> GENotifier

_hasFocus

protected boolean _hasFocus

Constructor Detail

FIBWidgetViewImpl

protected FIBWidgetViewImpl(M model,
                            FIBController aController,
                            <any> RenderingAdapter)

Method Detail

componentBecomesVisible

protected void componentBecomesVisible()

Description copied from class: FIBViewImpl

Called when the component view explicitely change its visibility state from INVISIBLE to VISIBLE

Overrides:

componentBecomesVisible in class FIBViewImpl<M extends FIBWidget,C>

componentBecomesInvisible

protected void componentBecomesInvisible()

Description copied from class: FIBViewImpl

Called when the component view explicitely change its visibility state from VISIBLE to INVISIBLE

Overrides:

componentBecomesInvisible in class FIBViewImpl<M extends FIBWidget,C>

makeTechnologyComponent

protected abstract C makeTechnologyComponent()

Create technology-specific component representing FIBWidget

Returns:

getTechnologyComponent

public final C getTechnologyComponent()

Return technology-specific component representing widget
Note that, depending on the underlying technology, this technology-specific component might be embedded in an other component before to be added in component hierarchy (for example if component need to be embedded in a scroll pane)

Specified by:

getTechnologyComponent in class FIBViewImpl<M extends FIBWidget,C>

Returns:

C

getTechnologyComponentForFIBComponent

public Object getTechnologyComponentForFIBComponent(FIBComponent component)

Return technology component for supplied FIBComponent
Return technology component if supplied FIBComponent is the represented widget itself, otherwise return null

Parameters:

component -

Returns:

getNotifier

public <any> getNotifier()

lockListening

public void lockListening()

allowListening

public void allowListening()

isListeningLocked

public boolean isListeningLocked()

executeEvent

public void executeEvent(EventDescription e)

delete

public void delete()

Overrides:

delete in class FIBViewImpl<M extends FIBWidget,C>

getWidget

public M getWidget()

updateData

public T updateData()

This method is called whenever a notification has been raised, changing the value expressed by data binding (the value beeing represented by this widget)
This method first compute the value, set the dynamic value stored in this widget with this new value, and then update the widget with the new computed value.
This method should be overriden in sub-classes

Returns:

the value as it has been computed from the model

focusGained

public final void focusGained(FocusEvent event)

focusLost

public final void focusLost(FocusEvent event)

gainFocus

protected final void gainFocus()

looseFocus

protected final void looseFocus()

componentGainsFocus

protected void componentGainsFocus()

Called when the component view explicitely changes its focus state from UNFOCUSED to FOCUSED

componentLoosesFocus

protected void componentLoosesFocus()

Called when the component view explicitely changes its focus state from FOCUSED to UNFOCUSED

isFocused

public boolean isFocused()

getRepresentedValue

public T getRepresentedValue()

hasValue

public final boolean hasValue()

Return boolean indicating if represented widget defines a value binding (a connection to some data)

getValue

public T getValue()

Return the value represented by the widget
Note that if value binding has been set for related FIBWidget, return the value computed from the value binding
If no value was declared, return the value represented by this FIBWidgetView

Returns:

setValue

public void setValue(T aValue)

Programmatically sets the value represented by the widget

Parameters:

value -

performValueChangedAction

protected void performValueChangedAction()

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Overrides:

propertyChange in class FIBViewImpl<M extends FIBWidget,C>

performUpdate

protected void performUpdate()

Internally called to update the view, once the visibility has been handled by FIBViewImpl.update() method

Overrides:

performUpdate in class FIBViewImpl<M extends FIBWidget,C>

updateComponentsExplicitelyDeclaredAsDependant

protected void updateComponentsExplicitelyDeclaredAsDependant()

updateLanguage

public void updateLanguage()

Specified by:

updateLanguage in class FIBViewImpl<M extends FIBWidget,C>

isReadOnly

public boolean isReadOnly()

isWidgetEnabled

public final boolean isWidgetEnabled()

isComponentEnabled

public final boolean isComponentEnabled()

getStringRepresentation

public String getStringRepresentation(Object value)

getIconRepresentation

public Icon getIconRepresentation(Object value)

applySingleClickAction

public void applySingleClickAction(FIBMouseEvent event)

Called after the platform-specific controller has detected a mouse event matching a single-click action

Parameters:

event - platform-specific event which is translated into a generic FIBMouseEvent

applyDoubleClickAction

public void applyDoubleClickAction(FIBMouseEvent event)

Called after the platform-specific controller has detected a mouse event matching a double-click action

Parameters:

event - platform-specific event which is translated into a generic FIBMouseEvent

applyRightClickAction

public void applyRightClickAction(FIBMouseEvent event)

Called after the platform-specific controller has detected a mouse event matching a right-click action

Parameters:

event - platform-specific event which is translated into a generic FIBMouseEvent

getDefaultData

public T getDefaultData()

Overrides:

getDefaultData in class FIBViewImpl<M extends FIBWidget,C>

updateFont

public void updateFont()

Specified by:

updateFont in class FIBViewImpl<M extends FIBWidget,C>

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

updateEnability

public final void updateEnability()

Called when a widget becomes visible
There is no guarantee that widget is in sync with the model, so, we need to call updateWidgetFromModel again

invokeLater

public void invokeLater(Runnable r,
                        long aggregationTimeOut)

Semantics of this method is not trivial: the goal is to aggregate some notifications within a given time (supplied as a aggregationTimeOut), to do it only once.
Within this delay, all requests to this method will simply reinitialize time-out, and will be ignored. Only the first call will be executed in a new thread which will die immediately after.

Parameters:

r - runnable to run after last request + timeout

aggregationTimeOut - in milliseconds

trimString

protected static List<String> trimString(String s,
                                         int width,
                                         FontMetrics fm)

indexOfFirstCharExceeding

protected static int indexOfFirstCharExceeding(String s,
                                               int width,
                                               FontMetrics fm)