com.iplanet.jato.view
Interface View

All Known Subinterfaces:
BooleanDisplayField, CommandField, ContainerView, DisplayField, HtmlDisplayField, SelectableGroup, TiledView, TreeView, ViewBean
All Known Implementing Classes:
ViewBase

public interface View

View is the abstract type of all elements that can display themselves as part of a JSP/HTML page. This interface is minimal and provides no direct support for display; such functionality is left to types deriving from this interface.

Views can be parented by other views, and thus arbitrarily nested. The interaction between parent and child views is further specified in specializations of this interface, such as ContainerView.

Version:
JATO/1.2.2 $Id: View.java,v 1.8 2002/03/16 03:26:41 todd Exp $

Field Summary
static java.lang.String QUALIFIED_VIEW_NAME_SEPARATOR
           
 
Method Summary
 java.lang.String getName()
          Returns the logical name of this view.
 View getParent()
          Returns this view's parent view, if any.
 java.lang.String getQualifiedName()
          Returns the name of this view qualified by its parent's qualified name (which also contains its parent's qualified name, and so on).
 void setParent(View parent)
          Set's this view's parent view.
 

Field Detail

QUALIFIED_VIEW_NAME_SEPARATOR

public static final java.lang.String QUALIFIED_VIEW_NAME_SEPARATOR
Method Detail

getName

public java.lang.String getName()
Returns the logical name of this view. This name can be any arbitrary string, and is specific to this view alone regardless of containership or other relationships. Because of the use of nested views, users should avoid using periods (".") in the name of a view, as they are normally used to separate parent and child names in a view's qualified name.
Returns:
The opaque, arbitrary name of this View

getQualifiedName

public java.lang.String getQualifiedName()
Returns the name of this view qualified by its parent's qualified name (which also contains its parent's qualified name, and so on).
Returns:
The fully-qualified name of this view, including its parent's qualified name. Components of the qualified name are normally dot-separated. (The current implementation relies on dot-seperated names).

getParent

public View getParent()
Returns this view's parent view, if any. The relationship of parent to child usually indicates a containership relationship, though that is not necessarily the case.
Returns:
The parent view, or null if this view has no parent

setParent

public void setParent(View parent)
Set's this view's parent view. A view must make all necessary changes to its internal state to reflect this change when this method is called. Such changes might include recaclulating its qualified name, calling registration methods on its parent, or checking the type of its parent to customize its display properties.
Parameters:
parent - The parent view, or null if this view has no parent