com.yworks.yfiles.view

Class FocusIndicatorManager<T extends ILookup>

java.lang.Object

com.yworks.yfiles.view.ModelManager<T>

com.yworks.yfiles.view.FocusIndicatorManager<T>

Type Parameters:

T - The type of the items.

public class FocusIndicatorManager<T extends ILookup>
extends ModelManager<T>

A ModelManager implementation that manages the visual decoration of the focused element in a canvas.

For the item that should be focused this class uses the ILookup mechanism of the item to lookup an IFocusIndicatorInstaller implementation which will do the actual installation of the decoration in the canvas.

Constructor Summary

Constructors

Constructor and Description
FocusIndicatorManager(CanvasControl canvas) Creates an instance that for all focused items in the model dynamically installs a decoration.

Method Summary

Modifier and Type	Method and Description
protected ICanvasObject	add(T item) Overridden to do nothing.
void	addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Adds the given listener for the PropertyChanged event that occurs when the FocusedItem property has been changed.
protected ICanvasObjectGroup	getCanvasObjectGroup(T item) Callback used by ModelManager.install(java.lang.Object) to retrieve the installer for a given item.
T	getFocusedItem() Gets the focused item, updates the canvas and fires the corresponding property change event.
protected ICanvasObjectInstaller	getInstaller(T item) Callback used by ModelManager.install(java.lang.Object) to retrieve the installer for a given item.
ShowFocusPolicy	getShowFocusPolicy() Gets the show focus policy.
boolean	isFocused() Gets a value indicating whether the container this manager is installed in currently is focused.
protected void	onDisabled() Called when this mode gets disabled.
protected void	onEnabled() Called when this mode gets enabled.
protected void	onFocusedChanged() Called when the Focused property has changed.
protected void	onPropertyChanged(PropertyChangedEventArgs args) Callback method that is triggered when the focused item has changed.
protected void	remove(T item) Overridden to do nothing.
void	removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Removes the given listener for the PropertyChanged event that occurs when the FocusedItem property has been changed.
void	setFocused(boolean value) Sets a value indicating whether the container this manager is installed in currently is focused.
void	setFocusedItem(T value) Sets the focused item, updates the canvas and fires the corresponding property change event.
void	setShowFocusPolicy(ShowFocusPolicy value) Sets the show focus policy.

Methods inherited from class com.yworks.yfiles.view.ModelManager

getCanvas, install, isEnabled, setEnabled, unInstall

Methods inherited from class java.lang.Object

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

Constructor Detail

FocusIndicatorManager

public FocusIndicatorManager(CanvasControl canvas)

Creates an instance that for all focused items in the model dynamically installs a decoration.

Parameters:

canvas - The canvas to add the focus marks to.

Method Detail

add

protected ICanvasObject add(T item)

Overridden to do nothing.

Overrides:

add in class ModelManager<T extends ILookup>

Parameters:

item - The item to add.

Returns:

The newly created canvas object or null if nothing was installed.

addPropertyChangedListener

public final void addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Adds the given listener for the PropertyChanged event that occurs when the FocusedItem property has been changed.

Parameters:

propertyChangedEvent - The listener to add.

See Also:

removePropertyChangedListener(IEventHandler)

getCanvasObjectGroup

protected ICanvasObjectGroup getCanvasObjectGroup(T item)

Callback used by ModelManager.install(java.lang.Object) to retrieve the installer for a given item.

This implementation always returns the FocusGroup of the Canvas of this instance.

Specified by:

getCanvasObjectGroup in class ModelManager<T extends ILookup>

Parameters:

item - The item to find a canvas object group for.

Returns:

An ICanvasObjectGroup or null

getFocusedItem

public final T getFocusedItem()

Gets the focused item, updates the canvas and fires the corresponding property change event.

Returns:

The focused item, which can be null.

See Also:

setFocusedItem(ILookup)

getInstaller

protected ICanvasObjectInstaller getInstaller(T item)

Callback used by ModelManager.install(java.lang.Object) to retrieve the installer for a given item.

This implementation uses the ILookup.lookup(java.lang.Class) of the item to retrieve an IFocusIndicatorInstaller instance.

Specified by:

getInstaller in class ModelManager<T extends ILookup>

Parameters:

item - The item to find an installer for.

Returns:

An installer or null

getShowFocusPolicy

public final ShowFocusPolicy getShowFocusPolicy()

Gets the show focus policy.

The default is ShowFocusPolicy.WHEN_FOCUSED.

Returns:

The show focus policy. Changing this property influences the visibility of the rendering depending on the current value of Focused attribute.

See Also:

setShowFocusPolicy(ShowFocusPolicy)

isFocused

public final boolean isFocused()

Gets a value indicating whether the container this manager is installed in currently is focused.

Returns:

true if the container is currently focused; false otherwise. Depending on the ShowFocusPolicy, this will influence the visibility of the rendering.

See Also:

setFocused(boolean)

onDisabled

protected void onDisabled()

Description copied from class: ModelManager

Called when this mode gets disabled.

Specified by:

onDisabled in class ModelManager<T extends ILookup>

onEnabled

protected void onEnabled()

Description copied from class: ModelManager

Called when this mode gets enabled.

Specified by:

onEnabled in class ModelManager<T extends ILookup>

onFocusedChanged

protected void onFocusedChanged()

Called when the Focused property has changed.

See Also:

isFocused()

onPropertyChanged

protected void onPropertyChanged(PropertyChangedEventArgs args)

Callback method that is triggered when the focused item has changed.

This method raises the PropertyChanged event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters:

args - a description of the event

See Also:

getFocusedItem(), addPropertyChangedListener(IEventHandler)

remove

protected void remove(T item)

Overridden to do nothing.

Overrides:

remove in class ModelManager<T extends ILookup>

Parameters:

item - The item to remove.

removePropertyChangedListener

public final void removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Removes the given listener for the PropertyChanged event that occurs when the FocusedItem property has been changed.

Parameters:

propertyChangedEvent - The listener to remove.

See Also:

addPropertyChangedListener(IEventHandler)

setFocused

public final void setFocused(boolean value)

Sets a value indicating whether the container this manager is installed in currently is focused.

Parameters:

value - true if the container is currently focused; false otherwise. Depending on the ShowFocusPolicy, this will influence the visibility of the rendering.

See Also:

isFocused()

setFocusedItem

public final void setFocusedItem(T value)

Sets the focused item, updates the canvas and fires the corresponding property change event.

Parameters:

value - The focused item, which can be null.

See Also:

getFocusedItem()

setShowFocusPolicy

public final void setShowFocusPolicy(ShowFocusPolicy value)

Sets the show focus policy.

The default is ShowFocusPolicy.WHEN_FOCUSED.

Parameters:

value - The show focus policy. Changing this property influences the visibility of the rendering depending on the current value of Focused attribute.

See Also:

getShowFocusPolicy()