Packagecom.yworks.graph.drawing
Classpublic class TagOwnerUserTagProvider
InheritanceTagOwnerUserTagProvider Inheritance Object
Implements IUserTagProvider

A IUserTagProvider instance which retrieves the user tag from the model item's ITagOwner.


Public Properties
 PropertyDefined By
  instance : TagOwnerUserTagProvider
[static] [read-only] The shared instance.
TagOwnerUserTagProvider
Public Methods
 MethodDefined By
  
getUserTag(forItem:IModelItem, context:ILookup):Object
Gets a user-defined object, the user tag, from the given model item's tag owner.
TagOwnerUserTagProvider
  
setUserTag(forItem:IModelItem, newTag:Object, context:ILookup):Boolean
Sets a user-defined object, the user tag, on the given model item's tag owner.
TagOwnerUserTagProvider
Property Detail
instanceproperty
instance:TagOwnerUserTagProvider  [read-only]

The shared instance.


Implementation
    public static function get instance():TagOwnerUserTagProvider
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's tag owner.

Parameters

forItem:IModelItem — The model item to get the user tag from.
 
context:ILookup — .A lookup to get extra information from. Not used here.

Returns
Object — A user-defined object which is retrieved from the model item's ITagOwner 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's tag owner.

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. Not used here.

Returns
Boolean — true if the new tag has been successfully set.




Wed Oct 7 2015, 04:52 PM +02:00