Package org.eclnt.jsfserver.pagebean

Interface IPageBean

All Superinterfaces:
IDynamicContentBindingObject
All Known Subinterfaces:
IPageBeanComponent, IPageBeanComponentAsControl, IWorkpageContainerPartialRenderer, IWorkpageContainerRenderer, IWorkpageSelector
All Known Implementing Classes:
ComplexValueEditor, DefaultDispatchedPageBean, DefaultScreens, DynBeanTreeUI, DynBeanUI, GridDetails, KEYSELECTORBinding, LogViewer, NullContentWrapper, PageBean, PageBeanComponent, PageBeanComponentAsControl, PageBeanComponentAsControlWithAction, PageBeanComponentBase, ROWComplexValueEditor, ServerFileBrowser, StreamStoreDetailUI, StreamStoreNewContentUI, StreamStoreTreeUI, WorkpageContainerRendererIconSelectorRight, WorkpageContainerRendererStackedPane, WorkpageContainerRendererVerticalMiniView, WorkpageContainerRendererViaHideablePane, WorkpageDispatchedPageBean, WorkplaceFoldableFunctionTrees, WorkplaceFunctionSearchUI
public interface IPageBean extends IDynamicContentBindingObject
Bean that serves as implementation of the view logic for a certain layout.

Page beans are re-useable parts of a dialog. The usage in a layout is done by component ROWPAGEBEANINCLUDE and PAGEBEANINCLUDE.

  • Method Details

    • getPageName

      String getPageName()
      Name of page that is managed by the bean. This can either be a static return value that stays fix for the whole lifecycle of the bean, or it may also be a value that changed - in case there are several pages that are possible to be managed by the page bean.

    • getRootExpressionUsedInPage

      String getRootExpressionUsedInPage()
      Inside the page definition the bean is addressed via a certain root expression - e.g. "#{d.XYZBean}". The page bean management requires this expression in order to execute certain expression replacements when loading the page at runtime.

    • setActualRootExpression

      void setActualRootExpression(String rootExpression)
      For internal usage only! - This property is set as part of the component processing of component ROWPAGEBEANINCLUDE. It must not be set by any other function!

    • getActualRootExpression

      String getActualRootExpression()
      Returns the actual root expression during runtime.

    • openModalPopup

      ModalPopup openModalPopup(IPageBean pageBean, String title, int width, int height, ModalPopup.IModalPopupListener popupListener)
      Opens a modal popup with an other page beans's content.

    • closePopup

      void closePopup(IPageBean pageBean)
      Closes a modal popup that was opened before.

    • openModelessPopup

      ModelessPopup openModelessPopup(IPageBean pageBean, String title, int width, int height, ModelessPopup.IModelessPopupListener popupListener)
      Opens a modeless popup with an other page beans's content.

    • onBeforeRendering

      void onBeforeRendering()
      Called before the rendering of the component content will be executed. The component may update/ rightsize/ refresh its data internally.

    • getPageModifier

      IPageModifier getPageModifier()
      Function to update the layout XML that is read by the page bean.

    • getStamp

      long getStamp()
      Each page bean has a creation stamp which is unique within a VM context. The stamp does not need to be unique "forever" (i.e. it's not a UUID). It serves as information for checking if a bean changed: instead of keeping the bean before and then comparing with the current bean with "==", you can keep the stamp information and compare the stamps. This means that in such situations the "bean before" can be garbage collected and is not kept just for comparison reason. - The value "0" is a reserved value and is never used as stamp.