IBM Rational Software Modeler
Release 6.0

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

All Superinterfaces:
IProvider

public interface ILayoutNodesProvider
extends IProvider

The interface for providers of the layout provider extension point. Implement this interface to contribute an extension to the "layoutProviders" extension point. The layoutNodes(List, boolean, IAdaptable) method call is invoked by internal presentation code for "arrange" actions. Consideration of dependencies has to be done when choosing the priority of the provider. The layout operation is executed on the first provider (in descending order of priority) that is found to provide the operation. Implementors are not expected to start read/write operations.


Field Summary
static String DEFAULT_LAYOUT
           
static String RADIAL_LAYOUT
           
 
Method Summary
 Runnable layoutNodes(List layoutNodes, boolean offsetFromBoundingBox, IAdaptable layoutHint)
          layoutNodes Layout this map of nodes, using the specified layout hint.
 
Methods inherited from interface com.ibm.xtools.common.core.service.IProvider
addProviderChangeListener, provides, removeProviderChangeListener
 

Field Detail

DEFAULT_LAYOUT

public static final String DEFAULT_LAYOUT

RADIAL_LAYOUT

public static final String RADIAL_LAYOUT
Method Detail

layoutNodes

public Runnable layoutNodes(List layoutNodes,
                            boolean offsetFromBoundingBox,
                            IAdaptable layoutHint)
layoutNodes Layout this map of nodes, using the specified layout hint.

Parameters:
layoutNodes - List of ILayoutNode objects that are to participate in the layout.
offsetFromBoundingBox - boolean indicating whether the Nodes should be laid out relative to the bounding box of the Nodes in the nodesToSizes Map.
layoutHint - 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.
Returns:
Runnable that contains the layout changes to be executed.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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