y.layout
Interface EdgeLabelLayout

All Superinterfaces:
LabelLayout, LabelLayoutConstants
All Known Implementing Classes:
EdgeLabel, EdgeLabelLayoutImpl

public interface EdgeLabelLayout
extends LabelLayout, LabelLayoutConstants

This interface defines the properties of one edge label from the perspective of a labelling algorithm.


Field Summary
 
Fields inherited from interface y.layout.LabelLayoutConstants
PLACE_ANYWHERE, PLACE_AT_CENTER, PLACE_AT_SOURCE, PLACE_AT_TARGET, PLACE_LEFT_OF_EDGE, PLACE_ON_EDGE, PLACE_RIGHT_OF_EDGE, PLACEMENT_ALONG_EDGE_MASK, PLACEMENT_ON_SIDE_OF_EDGE_MASK
 
Method Summary
 EdgeLabelModel getLabelModel()
          Returns the edge label model associated with this label layout
 byte getPreferredPlacement()
          Returns the preferred placement of this label.
 
Methods inherited from interface y.layout.LabelLayout
getBox, getModelParameter, setModelParameter
 

Method Detail

getLabelModel

public EdgeLabelModel getLabelModel()
Returns the edge label model associated with this label layout


getPreferredPlacement

public byte getPreferredPlacement()
Returns the preferred placement of this label. This feature is being interpreted by label aware layout algorithms.

Returns:
an ORed combination of LabelLayoutConstants.PLACE_ANYWHERE, LabelLayoutConstants.PLACE_AT_SOURCE, LabelLayoutConstants.PLACE_AT_TARGET or LabelLayoutConstants.PLACE_AT_CENTER and LabelLayoutConstants.PLACE_LEFT_OF_EDGE, LabelLayoutConstants.PLACE_RIGHT_OF_EDGE and LabelLayoutConstants.PLACE_ON_EDGE
See Also:
LabelLayoutConstants

© Copyright 2000-2003,
yWorks GmbH.
All rights reserved.

2003