All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.beans.tools.assembly.SubAssemblyView

public interface interface SubAssemblyView
This interface defines the methods that a class must support to provide a user interface for interacting with a particular subassembly model. If desired, a subassembly model can define more than one type of view for use with its underlying model.

The assembly surface tool provides a way for the user to select which view to use based on information supplied by its associated subassembly. The user interface supplied by the view is designed to integrate into the assembly tool user interface or run independently in a separate top-level window.

See Also:
Assembly, SubAssembly

Variable Index

 o CENTER
Indicates that the subassembly view component should appear in the center of the assembly tool.
 o LEFT
Indicates that the subassembly view component should appear on the left side of the assembly tool.
 o RIGHT
Indicates that the subassembly view component should appear on the right side of the assembly tool.

Method Index

 o close()
Closes a view.
 o getComponent()
Returns the component containing the user interface for the view.
 o getMenu()
Returns the submenu (if any) the view wants to add to the assembly tool main menu bar.
 o getPosition()
Returns the preferred position of the subassembly view component within the assembly tool.
 o open()
Opens a view.
 o select()
Informs the view that the user selected a view in the assembly tool.
 o setAssembly(Assembly)
Sets the assembly associated with the view.
 o setSubAssembly(SubAssembly)
Sets the subassembly asscociated with the view.

Variables

 o LEFT
 public static final int LEFT
Indicates that the subassembly view component should appear on the left side of the assembly tool.

 o CENTER
 public static final int CENTER
Indicates that the subassembly view component should appear in the center of the assembly tool.

 o RIGHT
 public static final int RIGHT
Indicates that the subassembly view component should appear on the right side of the assembly tool.

Methods

 o setAssembly
 public abstract void setAssembly(Assembly am)
Sets the assembly associated with the view. This method is called by the assembly to inform the view with which assembly the view is associated.

Parameters:
am - The assembly model associated with this view.
 o setSubAssembly
 public abstract void setSubAssembly(SubAssembly sam)
Sets the subassembly asscociated with the view. This method is called by the assembly to inform the view with which subassembly model the view is associated.

Note that it is possible for a view to be associated with more than one model over its lifetime.

Parameters:
sam - The subassembly model associated with this view.
 o open
 public abstract void open()
Opens a view. This method is called by the assembly to inform the view that it should make itself visible to the user. If the view's getComponent() method did not return null, the assembly directly sets the size and position of the view component based on information it has stored concerning user preferences. If the getComponent() method returned null, then the view must set its own initial size and position on the desktop.

 o close
 public abstract void close()
Closes a view. This method is called by the assembly to inform the view that the user requested the view to be closed.

Note that in this case the view should not invoke the assembly closedView() method, because the assembly is already aware that the view is being closed.

 o select
 public abstract void select()
Informs the view that the user selected a view in the assembly tool. This method is called by the assembly to inform the view that the user has selected the view in the assembly tool.

 o getComponent
 public abstract Component getComponent()
Returns the component containing the user interface for the view. This method is called by the assembly to obtain the AWT component representing the view. Depending on user preferences, this component is then added to an assembly tool notebook page or installed within a separate Frame window.

Returns:
The AWT component containing the user interface for this view.
 o getMenu
 public abstract Menu getMenu()
Returns the submenu (if any) the view wants to add to the assembly tool main menu bar. This method is called by the assembly after the view has been created to allow it to specify which submenu is to be added to the main tool menu bar. If null is returned, no submenu is added to the main menu.

Returns:
The submenu containing the menu items for use with this view.
 o getPosition
 public abstract int getPosition()
Returns the preferred position of the subassembly view component within the assembly tool. The possible values are: LEFT, CENTER, and RIGHT. These values refer to their relative placement within the assembly tool.

Returns:
The preferred location of the subassembly view component within the assembly tool.

All Packages  Class Hierarchy  This Package  Previous  Next  Index