com.anabas.sharedlet
Interface LayoutService


public interface LayoutService
extends SharedletService

The layout service examines the SharedletViewInfo for view constraints and renders them to the screen for the user to see. It provides some public API's for activating and deactivating views.

Location In GXO

A sharedlet can find the LauncherService under the meeting context:

/services/LayoutServce


Method Summary
 void activateView(SharedletView view)
          Activates a particular view by making it visible and ready for user input.
 void activateViews(java.lang.String mimeType)
          Activate all of the views for a sharedlet type.
 void addLayoutListener(LayoutServiceListener l)
           
 void deactivateView(SharedletView view)
          Deactivates a particular view by making it invisible.
 void deactivateViews(java.lang.String mimeType)
          Deactivate all of the views for a sharedlet type.
 java.awt.Dimension getRegionDimension(java.lang.String region)
          Gets the absolute screen dimensions for a view.
 java.awt.Point getRegionPosition(java.lang.String region)
          Gets the absolute screen position for a particular view.
 java.lang.String[] getSupportedRegions()
          Holds a list of supported regions.
 void removeLayoutListener(LayoutServiceListener l)
           
 
Methods inherited from interface com.anabas.sharedlet.SharedletService
init, resume, shutdown, suspend
 

Method Detail

addLayoutListener

public void addLayoutListener(LayoutServiceListener l)
Parameters:
l - Listener to listen for layout service events.

removeLayoutListener

public void removeLayoutListener(LayoutServiceListener l)
Parameters:
l - Listener to listen for layout service events.

activateViews

public void activateViews(java.lang.String mimeType)
Activate all of the views for a sharedlet type.
Parameters:
mimeType - The sharedlet mimeType to Activate.

deactivateViews

public void deactivateViews(java.lang.String mimeType)
Deactivate all of the views for a sharedlet type.
Parameters:
mimeType - The sharedlet mimeType to deactivate.

activateView

public void activateView(SharedletView view)
Activates a particular view by making it visible and ready for user input.
Parameters:
mimeType - The sharedlet mimeType to activate.

deactivateView

public void deactivateView(SharedletView view)
Deactivates a particular view by making it invisible.
Parameters:
mimeType - The sharedlet mimeType to deactivate.

getSupportedRegions

public java.lang.String[] getSupportedRegions()
Holds a list of supported regions. The layout service should read the region a view should go in by checking the "region" constraint parameter in ViewConstraints.
Returns:
The list of supported region names. An array of String's

getRegionPosition

public java.awt.Point getRegionPosition(java.lang.String region)
Gets the absolute screen position for a particular view.
Parameters:
region - The region name. The same as the SharedletViewConstraints' region name parameter.
Returns:
The screen x,y of the region specified. null if the region does not exist.

getRegionDimension

public java.awt.Dimension getRegionDimension(java.lang.String region)
Gets the absolute screen dimensions for a view.
Parameters:
region - The region name. The same as the SharedletViewConstraints' region name parameter.
Returns:
The size of the region specified. null if the region does not exist.