com.yworks.yfiles.graph.styles

Class AbstractTemplateStyle<TModelItem extends IModelItem>

java.lang.Object

com.yworks.yfiles.graph.styles.AbstractTemplateStyle<TModelItem>

Type Parameters:

TModelItem - The type of the model item.

All Implemented Interfaces:

ICloneable, Cloneable

Direct Known Subclasses:

TemplateLabelStyle, TemplateNodeStyle, TemplatePortStyle, TemplateStripeStyle

public abstract class AbstractTemplateStyle<TModelItem extends IModelItem>
extends Object
implements ICloneable, Cloneable

Abstract base class for styles that renders complex Nodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTemplateStyle() Constructs a new instance of this style with default values.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Adds the given listener for the PropertyChanged event that occurs when a property value changes.
AbstractTemplateStyle<TModelItem>	clone() Performs a shallow clone of this instance, except for the value of StyleTag which is cloned, too, if it can be cloned.
String	getCanvasPropertyKey()
static DelegatingClassLoader	getClassLoader()
String	getContentPropertyKey()
IContextLookup	getContextLookup() Gets an implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to INodeStyleRenderer.getContext(com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.styles.INodeStyle) that are made on the style renderer that is associated with this style instance.
static FXMLLoader	getFXMLLoader()
String	getItemPropertyKey()
Object	getStyleTag() Gets the tag that is associated with this style instance.
protected void	onPropertyChanged(PropertyChangedEventArgs e) Raises the PropertyChanged event.
void	removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent) Removes the given listener for the PropertyChanged event that occurs when a property value changes.
void	setCanvasPropertyKey(String canvasPropertyKey)
static void	setClassLoader(DelegatingClassLoader classLoader)
void	setContentPropertyKey(String contentPropertyKey)
void	setContextLookup(IContextLookup value) Sets an implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to INodeStyleRenderer.getContext(com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.styles.INodeStyle) that are made on the style renderer that is associated with this style instance.
void	setItemPropertyKey(String itemPropertyKey)
void	setStyleTag(Object value) Sets the tag that is associated with this style instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTemplateStyle

protected AbstractTemplateStyle()

Constructs a new instance of this style with default values.

Method Detail

addPropertyChangedListener

public final void addPropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Adds the given listener for the PropertyChanged event that occurs when a property value changes.

Parameters:

propertyChangedEvent - The listener to add.

See Also:

removePropertyChangedListener(IEventHandler)

clone

public AbstractTemplateStyle<TModelItem> clone()

Performs a shallow clone of this instance, except for the value of StyleTag which is cloned, too, if it can be cloned.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A clone of this instance.

See Also:

Object.clone()

getCanvasPropertyKey

public String getCanvasPropertyKey()

getClassLoader

public static DelegatingClassLoader getClassLoader()

getContentPropertyKey

public String getContentPropertyKey()

getContextLookup

public final IContextLookup getContextLookup()

Gets an implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to INodeStyleRenderer.getContext(com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.styles.INodeStyle) that are made on the style renderer that is associated with this style instance.

This can be used to conveniently customize the lookup behavior of the style renderers that are associated with this instance. E.g. it is possible to provide customized implementations of ISelectionIndicatorInstaller, IHighlightIndicatorInstaller, IHandleProvider, INodeSizeConstraintProvider, and INodeInsetsProvider. Simple style implementations can use IContextLookup.EMPTY_CONTEXT_LOOKUP but may not use null for this property. The default value is IContextLookup.EMPTY_CONTEXT_LOOKUP

Returns:

The context implementation.

See Also:

setContextLookup(IContextLookup)

getFXMLLoader

public static FXMLLoader getFXMLLoader()

getItemPropertyKey

public String getItemPropertyKey()

getStyleTag

public final Object getStyleTag()

Gets the tag that is associated with this style instance.

The various style renderer implementations can use this tag to make it accessible in the context of the instantiated templates and controls. The framework does not make any assumptions about the value of this property. It is there for convenient use in the process of data binding the templates. This property supports property change notification and can thus be data bound easily.

Returns:

The tag associated with this style instance.

See Also:

setStyleTag(Object)

onPropertyChanged

protected void onPropertyChanged(PropertyChangedEventArgs e)

Raises the PropertyChanged event.

Parameters:

e - The PropertyChangedEventArgs instance containing the event data.

removePropertyChangedListener

public final void removePropertyChangedListener(IEventHandler<PropertyChangedEventArgs> propertyChangedEvent)

Removes the given listener for the PropertyChanged event that occurs when a property value changes.

Parameters:

propertyChangedEvent - The listener to remove.

See Also:

addPropertyChangedListener(IEventHandler)

setCanvasPropertyKey

public void setCanvasPropertyKey(String canvasPropertyKey)

setClassLoader

public static void setClassLoader(DelegatingClassLoader classLoader)

setContentPropertyKey

public void setContentPropertyKey(String contentPropertyKey)

setContextLookup

public final void setContextLookup(IContextLookup value)

Sets an implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to INodeStyleRenderer.getContext(com.yworks.yfiles.graph.INode, com.yworks.yfiles.graph.styles.INodeStyle) that are made on the style renderer that is associated with this style instance.

This can be used to conveniently customize the lookup behavior of the style renderers that are associated with this instance. E.g. it is possible to provide customized implementations of ISelectionIndicatorInstaller, IHighlightIndicatorInstaller, IHandleProvider, INodeSizeConstraintProvider, and INodeInsetsProvider. Simple style implementations can use IContextLookup.EMPTY_CONTEXT_LOOKUP but may not use null for this property. The default value is IContextLookup.EMPTY_CONTEXT_LOOKUP

Parameters:

value - The context implementation.

See Also:

getContextLookup()

setItemPropertyKey

public void setItemPropertyKey(String itemPropertyKey)

setStyleTag

public final void setStyleTag(Object value)

Sets the tag that is associated with this style instance.

The various style renderer implementations can use this tag to make it accessible in the context of the instantiated templates and controls. The framework does not make any assumptions about the value of this property. It is there for convenient use in the process of data binding the templates. This property supports property change notification and can thus be data bound easily.

Parameters:

value - The tag associated with this style instance.

See Also:

getStyleTag()