All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sas.servlet.tbeans.navigationbar
Class BaseNavigationBar

    com.sas.servlet.tbeans.navigationbar.BaseNavigationBar

All Implemented Interfaces:
  HttpActionProviderInterface, com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, com.sas.servlet.tbeans.AJAXControllerURLInterface, ComplexStyleInterface, CompositeComponentInterface, NavigationBarKeysInterface, RenderableInterface, TemplateInterface, com.sas.servlet.tbeans.TemplateKeyInterface, TransformationInterface, com.sas.servlet.tbeans.TransformationInterface2, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:
  NavigationBar

    public abstract class BaseNavigationBar

implements NavigationBarKeysInterface

The abstract Transformation Bean base object for creating a NavigationBar. A NavigationBar is used to scroll (or navigate) through a Transformation Bean that implements BaseNavigationInterface. A NavigationBar is a composite Transformation Bean that consists of multiple instances of `BaseNavigationBarElement`.

The model of a NavigationBar must implement `BaseNavigationInterface`.

Note that subclasses of this bean actually provide the markup rendering used in/with Servlet and JavaServer Pages technologies. If you need to add support for a markup language that is not explicitly provided with AppDev Studio, then you must extend this class.

For More Information:

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on these custom tags.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

See Also:
  `BaseNavigationBarElement`, `BaseNavigationInterface`, Serialized Form

Field Summary

Fields inherited from interface com.sas.servlet.tbeans.navigationbar.NavigationBarKeysInterface
`NAVIGATIONBAR_COLUMN_ELEMENT, NAVIGATIONBAR_EDIT_ELEMENT, NAVIGATIONBAR_ROW_ELEMENT`

Constructor Summary
`BaseNavigationBar()` Default Constructor

Method Summary
`BaseNavigationInterface` | `getModel()` Gets the model of the navigationbar.
`void` | `setModel(BaseNavigationInterface viewer)` Sets the model on all the navigationbar's elements currently attached to the navigationbar.
`protected void` | `writeContent(java.io.PrintWriter out)` Writes the transformation's main content which is everything except for the following: Opening container html element.

Methods inherited from class com.sas.servlet.tbeans.BaseCompositeTransformation
`applyTemplate, applyTemplate, getActionProvider, getComponent, getComponents, getDefaultTemplate, getStyleInfo, getStyleMap, getTemplate, getTemplateDictionary, getTemplateFileName, getTemplateLocation, getVisibleComponents, isFlushEnabled, propertyChange, removeComponent, setActionProvider, setCleanUpResourcesOn, setComponent, setFlushEnabled, setId, setLocale, setRequest, setResponse, setStyleInfo, setTemplate, setTemplate, setTemplateDictionary, setTemplateFileName, setTemplateLocation, writeTemplate`

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation
`addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCustomAttributes, setInputTransform, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setTagEpilog, setTagProlog, setVisible, toString, write, write, write`

Methods inherited from interface com.sas.servlet.tbeans.TransformationInterface
`getCustomAttributes, getDescription, getId, getLocale, getName, getRequest, getResponse, getTagEpilog, getTagProlog, isVisible, setCustomAttributes, setDescription, setId, setLocale, setName, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, write, write, write`

Methods inherited from interface com.sas.actionprovider.HttpActionProviderInterface
`getRequest`

Constructor Detail

### BaseNavigationBar

    public BaseNavigationBar()

  Default Constructor

Method Detail

### setModel

    public void setModel(BaseNavigationInterface viewer)

  Sets the model on all the navigationbar's elements currently attached to the navigationbar. This method will also set this model on the components that are attached to the NavigationBar using the following keys: NAVIGATIONBAR_ROW_ELEMENT, NAVIGATIONBAR_COLUMN_ELEMENT, NAVIGATIONBAR_EDIT_ELEMENT.

  Parameters:
    `model` - the model for the navigationbar's elements

### getModel

    public BaseNavigationInterface getModel()

  Gets the model of the navigationbar. Returns null if not set.

  Returns:
    the model for the navigationbar

### writeContent

    protected void writeContent(java.io.PrintWriter out)
                         throws java.io.IOException

  Description copied from class: `BaseCompositeTransformation2`
  Writes the transformation's main content which is everything except for the following:
  - Opening container html element.
  - Any content provided by preWrite() method
  - Any content provided by postWrite() method
  - Closing container html element.

  Specified by:
    `writeContent` in class `com.sas.servlet.tbeans.BaseCompositeTransformation2`
  Throws:
    `java.io.IOException`
  See Also:
    `BaseCompositeTransformation2.write(PrintWriter)`

All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009 SAS Institute Inc. All Rights Reserved.