Packagecom.yworks.io.graphml.realizer
Classpublic class AbstractNodeRealizerSerializer
InheritanceAbstractNodeRealizerSerializer Inheritance Object
Implements INodeRealizerSerializer
Subclasses ImageNodeStyleRealizerSerializer, ShapeNodeStyleRealizerSerializer

Abstract base class for realizerserializers that can read and/or write node graphics information written/to be parsed by yFiles Java


Public Methods
 MethodDefined By
  
canRead(node:XML, context:GraphMLParseContext):Boolean
Whether this instance can deserialize the given xml element in the given context.
AbstractNodeRealizerSerializer
  
canWrite(node:INode, context:GraphMLWriteContext):Boolean
Whether this instance can serialize the style of the given node in the given context.
AbstractNodeRealizerSerializer
  
createStyleInstance(element:XML, context:GraphMLParseContext):INodeStyle
Create a style instance that can represent the node graphics information of the given xml element.
AbstractNodeRealizerSerializer
  
getElementName(item:Object):String
Subclasses have to override this method.
AbstractNodeRealizerSerializer
  
getElementNames():Array
Subclasses have to override this method.
AbstractNodeRealizerSerializer
  
getNamespace():Namespace
Returns GraphMLConstants.YWORKS_EXT_NS.
AbstractNodeRealizerSerializer
  
getStyleClass():Class
Subclasses have to override this method.
AbstractNodeRealizerSerializer
  
parse(style:INodeStyle, layout:IMutableRectangle, element:XML, context:GraphMLParseContext):void
Parses a serialized yFiles Java node realizer into the given style.
AbstractNodeRealizerSerializer
  
write(node:INode, writer:IXmlWriter, context:GraphMLWriteContext):void
Write the given node style in a format that can be parsed into a node realizer by yFiles Java.
AbstractNodeRealizerSerializer
  
writeAttributes(node:INode, writer:IXmlWriter, context:GraphMLWriteContext):void
Write the attributes of the realizer xml element
AbstractNodeRealizerSerializer
Method Detail
canRead()method
public function canRead(node:XML, context:GraphMLParseContext):Boolean

Whether this instance can deserialize the given xml element in the given context.

Parameters

node:XML — The xml element.
 
context:GraphMLParseContext — The parse context.

Returns
Boolean — true if this instance can deserialize the given xml element
canWrite()method 
public function canWrite(node:INode, context:GraphMLWriteContext):Boolean

Whether this instance can serialize the style of the given node in the given context.

Parameters

node:INode — The node.
 
context:GraphMLWriteContext — The write context.

Returns
Boolean — true if this instance can serialize the given node's style.
createStyleInstance()method 
public function createStyleInstance(element:XML, context:GraphMLParseContext):INodeStyle

Create a style instance that can represent the node graphics information of the given xml element.

Parameters

element:XML — The xml element.
 
context:GraphMLParseContext — The parse context.

Returns
INodeStyle — An INodeStyle instance which is deserialized from the given xml element.
getElementName()method 
public function getElementName(item:Object):String

Subclasses have to override this method. Returns the name of the element that will be written by this serializer given the provided item.

Parameters

item:Object

Returns
String — the name of the item

Throws
IllegalOperationError, — if not overridden.
getElementNames()method 
public function getElementNames():Array

Subclasses have to override this method. Returns the names of all XML elements that can be parsed or written by this serializer.

Returns
Array — The names of all xml elements this serializer can handle as Array.

Throws
IllegalOperationError, — if not overridden.
getNamespace()method 
public function getNamespace():Namespace

Returns GraphMLConstants.YWORKS_EXT_NS. Returns the namespace of the element this serilaizer writes.

Returns
Namespace — the namespace of the elements
getStyleClass()method 
public function getStyleClass():Class

Subclasses have to override this method. Returns the style class that can be serialized or deserialized by this instance.

Returns
Class — The class that can be serialized by this instance.

Throws
IllegalOperationError, — if not overridden.
parse()method 
public function parse(style:INodeStyle, layout:IMutableRectangle, element:XML, context:GraphMLParseContext):void

Parses a serialized yFiles Java node realizer into the given style.

Parameters

style:INodeStyle — A node style that is used to display the appearance of the yFiles Java node realizer.
 
layout:IMutableRectangle — A mutable rectangle that will be set to the bounds of the parsed realizer.
 
element:XML — the graphml node element
 
context:GraphMLParseContext — the current parsing context

write()method 
public function write(node:INode, writer:IXmlWriter, context:GraphMLWriteContext):void

Write the given node style in a format that can be parsed into a node realizer by yFiles Java.

Parameters

node:INode — node whose style can be serialized to a format that can be read by yFiles Java.
 
writer:IXmlWriter — The xml writer
 
context:GraphMLWriteContext — The current write context.

writeAttributes()method 
public function writeAttributes(node:INode, writer:IXmlWriter, context:GraphMLWriteContext):void

Write the attributes of the realizer xml element

Parameters

node:INode — A node whose style can be serialized to a format that can be read by yFiles Java.
 
writer:IXmlWriter — The xml writer.
 
context:GraphMLWriteContext — The current write context.





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