artofillusion.view
Interface ViewerControl

All Known Implementing Classes:
ViewerOrientationControl, ViewerPerspectiveControl, ViewerScaleControl

public interface ViewerControl

A ViewerControl defines a Widget that is added to the toolbar at the top of each ViewerCanvas. After creating a ViewerControl, invoke ViewerCanvas.addViewerControl(ViewerControl) to register it. Every time a new ViewerCanvas is then created, createWidget() will be invoked to create a control for that canvas.


Method Summary
 Widget createWidget(ViewerCanvas view)
          This is invoked each time a new ViewerCanvas is created.
 java.lang.String getName()
          Get the name of this ViewerControl, as it should be displayed in the user interface.
 

Method Detail

createWidget

Widget createWidget(ViewerCanvas view)
This is invoked each time a new ViewerCanvas is created. It should create a Widget which is then added to the canvas' toolbar.

It is permitted for this method to return null. This allows a ViewerControl to only add Widgets to particular types of ViewerCanvases.


getName

java.lang.String getName()
Get the name of this ViewerControl, as it should be displayed in the user interface.



Copyright © 1999-2011 by Peter Eastman.