Package com.axemble.vdoc.sdk.navigations

Class BaseNavigation

java.lang.Object
com.axemble.vdp.ui.framework.foundation.Component
com.axemble.vdp.ui.framework.foundation.Widget
com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation
com.axemble.vdoc.sdk.navigations.BaseNavigation
All Implemented Interfaces:
IWidget, IWritable, com.axemble.vdp.ui.core.providers.INavigationListenerImpl, com.axemble.vdp.utils.parameters.ParamsHandler, Serializable
public abstract class BaseNavigation extends com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation implements com.axemble.vdp.ui.core.providers.INavigationListenerImpl
The BaseNavigation class allows to create any screen either from a HTML template or by using standard components. The BaseNavigation class provides direct access to the SDK API.

You can access the following methods:

  • getPortalModule() : the module to manipulate the back office system;
  • getDirectoryModule() : the module to manipulate the directory system;
  • getProjectModule() : the module to manipulate the project system;
  • getWorkflowModule() : the module to manipulate the workflow system;
Version:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation

    com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation.NamedWidget

  • Field Summary

    Fields inherited from class com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation

    cache, cssClass, cssDependencies, ctlFooter, currentTemplateName, customTemplates, formulaContext, isEmbedded, isFormNeeded, isInsideGroup, isInsidePanel, mobileContainer, screenElement, scriptDependencies, securityScope

    Fields inherited from class com.axemble.vdp.ui.framework.foundation.Widget

    actionListeners, isHidden, param, parentBlock, sysname, userId

    Fields inherited from class com.axemble.vdp.ui.framework.foundation.Component

    changeListeners, LOGGER

    Fields inherited from interface com.axemble.vdp.utils.parameters.ParamsHandler

    ERROR_EXCEED_ELEM_SIZE, ERROR_EXCEED_TOTAL_SIZE, ERROR_NOT_COMPLETED, ERROR_READ_FAILED, EXCEED_ELEM_NUMBER, NO_ERROR

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseNavigation(INavigateContext context)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final INavigateContext
    getContext()
     
    protected final IDirectoryModule
    getDirectoryModule()
     
    protected final IContext
    getLoggedOnContext()
     
    protected final IPlugin
    getPlugin()
     
    protected final IPortalModule
    getPortalModule()
     
    protected final IProjectModule
    getProjectModule()
     
    IProvider
    getProvider()
     
    String
    getScreenType()
     
    final ISiteModule
    getSiteModule()
     
    protected final String
    getTemplateAsString(String relativePath)
     
    protected final com.axemble.vdp.ui.framework.template.TemplateWriter
    getTemplateWriter(String relativePath)
     
    protected final IWorkflowModule
    getWorkflowModule()
     

    Methods inherited from class com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation

    addCssDependency, addRenderListener, addScriptDependency, afterExit, closeClient, customTemplateRenderFillContainer, customTemplateRenderFillSection, exitScreen, getCacheContext, getCssClass, getCssDependencies, getCurrentTemplateName, getCurrentTemplateWriter, getFormulaContext, getMobileContainer, getName, getNavigationActionListener, getNavigationChangeListener, getNavigationPluginStorageResourceActionListener, getRenderListeners, getScreenElement, getScriptDependencies, getSecurityScope, includeDependencies, init, initialize, initializeContext, isEmbedded, isFormNeeded, isInsideGroup, navigate, onExitScreen, removeRenderListener, removeRenderListeners, setCacheContext, setCssClass, setCurrentTemplate, setCustomTemplates, setEmbedded, setFormNeeded, setFormulaContext, setInsideGroup, setSecurityScope

    Methods inherited from class com.axemble.vdp.ui.framework.foundation.Widget

    addActionListener, afterInit, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireMessage, buildFireOnClickMessage, buildFireOnClickMessage, buildFormName, findFileRecipient, findStringRecipient, findXmlRecipient, fireActionEvent, focus, getCtrlTemplate, getCtrlTemplateWriter, getJavaScriptFocusScript, getJavascriptId, getParam, getParentBlock, getSysname, getUserDisplayName, getUserId, handleAction, handleParams, hasActionListeners, isHidden, refresh, refreshWidgets, removeActionListener, removeActionListeners, render, renderMobile, setHidden, setParam, setParentBlock, setSysname, setUserId, write

    Methods inherited from class com.axemble.vdp.ui.framework.foundation.Component

    addChangeListener, createComponent, evaluateExpressions, fireChangeEvent, getDynamicDescription, getDynamicLabel, getLanguage, getNavigator, getRootNavigator, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, hasChangeListeners, removeChangeListener, removeChangeListeners, stateChanged

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.axemble.vdp.ui.core.providers.INavigationListenerImpl

    addRenderListener, getCssClass, getName, getNavigationActionListener, getNavigationChangeListener, getRenderListeners, getScreenElement, getSecurityScope, init, initialize, isFormNeeded, navigate, onExitScreen

  • Constructor Details

  • Method Details

    • getTemplateWriter

      protected final com.axemble.vdp.ui.framework.template.TemplateWriter getTemplateWriter(String relativePath) throws RenderException
      Throws:
      RenderException

    • getTemplateAsString

      protected final String getTemplateAsString(String relativePath) throws RenderException
      Throws:
      RenderException

    • getContext

      public final INavigateContext getContext()
      Specified by:
      getContext in interface com.axemble.vdp.ui.core.providers.INavigationListenerImpl
      Overrides:
      getContext in class com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation

    • getSiteModule

      public final ISiteModule getSiteModule()

    • getPlugin

      protected final IPlugin getPlugin()
      Returns:
      the current plugin

    • getWorkflowModule

      protected final IWorkflowModule getWorkflowModule()
      Returns:
      the workflowModule

    • getPortalModule

      protected final IPortalModule getPortalModule()
      Returns:
      the portalModule

    • getDirectoryModule

      protected final IDirectoryModule getDirectoryModule()
      Returns:
      the directoryModule

    • getProjectModule

      protected final IProjectModule getProjectModule()
      Returns:
      the projectModule

    • getLoggedOnContext

      protected final IContext getLoggedOnContext()
      Returns:
      the loggedOnContext

    • getProvider

      public IProvider getProvider()
      Specified by:
      getProvider in class com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation

    • getScreenType

      public String getScreenType()
      Specified by:
      getScreenType in interface com.axemble.vdp.ui.core.providers.INavigationListenerImpl