Packagecom.yworks.graph.drawing
Interfacepublic interface IUserTagProvider
Implementors TagOwnerUserTagProvider

Provides the methods for getting and setting an arbitray user-defined object which is associated with a model item.



Public Methods
 MethodDefined By
  
getUserTag(forItem:IModelItem, context:ILookup):Object
Gets a user-defined object, the user tag, from the given model item.
IUserTagProvider
  
setUserTag(forItem:IModelItem, newTag:Object, context:ILookup):Boolean
Sets a user-defined object, the user tag, on the given model item.
IUserTagProvider
Method Detail
getUserTag()method
public function getUserTag(forItem:IModelItem, context:ILookup):Object

Gets a user-defined object, the user tag, from the given model item.

Parameters

forItem:IModelItem — The model item to get the user tag from.
 
context:ILookup — A lookup to get extra information from. Implementations don't necessary have to use this parameter.

Returns
Object — A user-defined object which is associated with the model item as user tag.
setUserTag()method 
public function setUserTag(forItem:IModelItem, newTag:Object, context:ILookup):Boolean

Sets a user-defined object, the user tag, on the given model item.

Parameters

forItem:IModelItem — The model item to set the user tag for.
 
newTag:Object — A user-defined object which is associated with the model item as user tag.
 
context:ILookup — A lookup to get extra information from. Implementations don't necessary have to use this parameter.

Returns
Booleantrue if the new tag has been successfully set.