EchoPoint
1.0

echopoint.layout
Interface LayoutManager

All Known Implementing Classes:
AbstractLayoutManager

public interface LayoutManager

The LayoutManager defines the interface for classes that know how to lay out Components.


Method Summary
 void addLayoutComponent(nextapp.echo.Component comp, java.lang.Object constraints)
          Adds a component to the LayoutManager with the specified contraints object.
 nextapp.echo.Component getComponent(java.lang.Object contraints)
          Returns the Component associated to the given Contraints object or null if there is no association.
 java.lang.Object getContraints(nextapp.echo.Component comp)
          Returns the contraints object associated to the given component or null if there is no association.
 LayoutManageable getLayoutManageable()
          This lifecycle method is called to retrieve the LayoutManageable component that is currently associated with this LayoutManager.
 void invalidateLayout(nextapp.echo.Component targetComp)
          Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
 void removeLayoutComponent(nextapp.echo.Component comp)
          Removes a component from the LayoutManager.
 void setLayoutManageable(LayoutManageable layoutManageable)
          This lifecycle method is called to inform the LayoutManager if its associated LayoutManageable component.
 

Method Detail

addLayoutComponent

public void addLayoutComponent(nextapp.echo.Component comp,
                               java.lang.Object constraints)
Adds a component to the LayoutManager with the specified contraints object. This method is called by the containing component when a new child component is added, with contraints.

The implementing LayoutManager must be able to handle "null" constraints objects.

This method is not intended to be called by any other than an LayoutManageable during Component add().


getComponent

public nextapp.echo.Component getComponent(java.lang.Object contraints)
Returns the Component associated to the given Contraints object or null if there is no association.


getContraints

public java.lang.Object getContraints(nextapp.echo.Component comp)
Returns the contraints object associated to the given component or null if there is no association.


getLayoutManageable

public LayoutManageable getLayoutManageable()
This lifecycle method is called to retrieve the LayoutManageable component that is currently associated with this LayoutManager. The LayoutManager is expected retrive the association that was previously set with setLayoutManageable or null.


invalidateLayout

public void invalidateLayout(nextapp.echo.Component targetComp)
Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.


removeLayoutComponent

public void removeLayoutComponent(nextapp.echo.Component comp)
Removes a component from the LayoutManager. This method is called by the containing component when a child component is to be removed.

This method is not intended to be called by any other than an LayoutManageable during Component remove().


setLayoutManageable

public void setLayoutManageable(LayoutManageable layoutManageable)
This lifecycle method is called to inform the LayoutManager if its associated LayoutManageable component. The LayoutManager is expected hold this association and return it should getLayoutManageable() be called.


EchoPoint
1.0