Packagecom.yworks.graph.model
Interfacepublic interface IChangeLabeledItemAppearanceCallback

Common base interface for both the IChangeDummyNodeAppearanceCallback and IChangeDummyEdgeAppearanceCallback.

This interface can be used to manage the labels of an ILabeledItem.

See also

IChangeDummyNodeAppearanceCallback
IChangeDummyEdgeAppearanceCallback


Public Methods
 MethodDefined By
  
addLabel(labelModelParameter:ILabelModelParameter, style:ILabelStyle, text:String, preferredWidth:Number, preferredHeight:Number):ILabel
Performs the IGraph#addLabel() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
Convenience method that removes all labels from the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
removeLabel(label:ILabel):void
Performs the IGraph#removeLabel() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
Performs the IGraph#setLabelModelParameter() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setLabelStyle(label:ILabel, style:ILabelStyle):void
Performs the IGraph#setLabelStyle() operation for the provided label that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setLabelTag(label:ILabel, newTag:Object):void
Sets the tag for the label of the item that that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setLabelText(label:ILabel, text:String):void
Performs the IGraph#setLabelText() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setPreferredSize(label:ILabel, width:Number, height:Number):void
Performs the IGraph#setPreferredSize() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
Method Detail
addLabel()method
public function addLabel(labelModelParameter:ILabelModelParameter, style:ILabelStyle, text:String, preferredWidth:Number, preferredHeight:Number):ILabel

Performs the IGraph#addLabel() operation for the item that this callback has been configured for.

Parameters

labelModelParameter:ILabelModelParameter — The label model parameter to use.
 
style:ILabelStyle — The style to use.
 
text:String — The text to assign.
 
preferredWidth:Number — The initial preferred width of the label to assign to the ILabel#preferredSize.
 
preferredHeight:Number — The initial preferred height of the label to assign to the ILabel#preferredSize.

Returns
ILabel — The label instance that has been added to the item.
clearLabels()method 
public function clearLabels():void

Convenience method that removes all labels from the item that this callback has been configured for.

See also

removeLabel()method 
public function removeLabel(label:ILabel):void

Performs the IGraph#removeLabel() operation for the item that this callback has been configured for.

Parameters

label:ILabel — The label instance to remove.

setLabelModelParameter()method 
public function setLabelModelParameter(label:ILabel, parameter:ILabelModelParameter):void

Performs the IGraph#setLabelModelParameter() operation for the item that this callback has been configured for.

Parameters

label:ILabel — The label to change.
 
parameter:ILabelModelParameter — The new parameter.

setLabelStyle()method 
public function setLabelStyle(label:ILabel, style:ILabelStyle):void

Performs the IGraph#setLabelStyle() operation for the provided label that this callback has been configured for.

Parameters

label:ILabel — The label instance to assign the ILabel#style property.
 
style:ILabelStyle — The style to assign.

setLabelTag()method 
public function setLabelTag(label:ILabel, newTag:Object):void

Sets the tag for the label of the item that that this callback has been configured for.

Parameters

label:ILabel — The label to change
 
newTag:Object — The new user tag

setLabelText()method 
public function setLabelText(label:ILabel, text:String):void

Performs the IGraph#setLabelText() operation for the item that this callback has been configured for.

Parameters

label:ILabel — The label to change.
 
text:String — The new text.

setPreferredSize()method 
public function setPreferredSize(label:ILabel, width:Number, height:Number):void

Performs the IGraph#setPreferredSize() operation for the item that this callback has been configured for.

Parameters

label:ILabel — The label to change.
 
width:Number — The width of the preferred size.
 
height:Number — The height of the preferred size.