Interface IUIRootContainer

public interface IUIRootContainer extends IUIContainer
{
  // Methods
  public void endMenu(IUIMenuLauncher ml, Event event);
  public void endTooltip();
  public IUIComponent getFocus();
  public Component getHost();
  public IUIMenuLauncher getLaunchedMenu();
  public void launchMenu(IUIMenuLauncher ml);
  public void launchTooltip(IUIComponent comp, String sTooltip);
  public void needsValidating(IUIComponent comp);
  public void setFocus(IUIComponent comp);
}

This interface is used by all root containers. A root container is a UI object that is hosted by an AwtUI control. UIRoot implements IUIRootContainer.

IUIComponent
  |
  +--IUIContainer
    |
    +--IUIRootContainer

Methods

endMenu

public void endMenu(IUIMenuLauncher ml, Event event);

Terminates the launch of the pop-up menu associated with the specified menu launcher.

Return Value:

No return value.

Parameter	Description
ml	The menu launcher that terminates the launch.
event	The event that will be fired by the caller after end is complete; null if no event will be fired.

endTooltip

public void endTooltip();

Terminates the currently launched ToolTip window.

Return Value:

No return value.

getFocus

public IUIComponent getFocus();

Retrieves the component that currently has focus.

Return Value:

Returns the component with focus.

getHost

public Component getHost();

Retrieves the host component that is associated with the root container.

Return Value:

Returns the component that hosts the root container.

getLaunchedMenu

public IUIMenuLauncher getLaunchedMenu();

Retrieves the menu launcher associated with the currently launched pop-up menu.

Return Value:

Returns the menu launcher object.

launchMenu

public void launchMenu(IUIMenuLauncher ml);

Launches the pop-up menu associated with the specified menu launcher. This method cancels any menu that was previously launched.

Return Value:

No return value.

Parameter	Description
ml	The menu launcher that is requesting the launch.

launchTooltip

public void launchTooltip(IUIComponent comp, String sTooltip);

Launches a ToolTip window using the specified string for content.

Return Value:

No return value.

Parameter	Description
comp	The component used to determine the size and placement of the ToolTip window.
sTooltip	The string to be displayed in the ToolTip window.

needsValidating

public void needsValidating(IUIComponent comp);

Indicates that the specified component needs to be validated.

Return Value:

No return value.

Parameter	Description
comp	The component to be validated.

setFocus

public void setFocus(IUIComponent comp);

Sets focus on the specified component.

Return Value:

No return value.

Parameter	Description
comp	The component to receive focus.