IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.presentation.services.layout
Interface ILayoutNodesOperation

All Superinterfaces:
IOperation

public interface ILayoutNodesOperation
extends IOperation

Interface describing the layout operation for a set of nodes with corresponding sizes. This interface can be used in the layout provider implementation class.


Method Summary
 IAdaptable getLayoutHint()
          getLayoutHint Retrieves the value of the layoutHint instance variable.
 List getLayoutNodes()
          getLayoutNodes Gets the list of nodes to layout.
 boolean shouldOffsetFromBoundingBox()
          shouldOffsetFromBoundingBox
 
Methods inherited from interface com.ibm.xtools.common.core.service.IOperation
execute
 

Method Detail

getLayoutNodes

public List getLayoutNodes()
getLayoutNodes Gets the list of nodes to layout.

Returns:
List of ILayoutNode objects that are to participate in the layout operation.

shouldOffsetFromBoundingBox

public boolean shouldOffsetFromBoundingBox()
shouldOffsetFromBoundingBox

Returns:
boolean indicating whether the Nodes should be laid out relative to the bounding box of the Nodes in the nodesToSizes Map.

getLayoutHint

public IAdaptable getLayoutHint()
getLayoutHint Retrieves the value of the layoutHint instance variable.

Returns:
IAdaptable hint to the provider to determine the layout kind. IAdaptable will typically adapt to string that can be one of ILayoutNodesProvider.DEFAULT_LAYOUT or ILayoutNodesProvider.RADIAL_LAYOUT.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.