Package org.eclnt.ccaddons.pbc

Class CCMultiPageContainer

java.lang.Object
org.eclnt.jsfserver.pagebean.PageBean
org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase
org.eclnt.jsfserver.pagebean.component.PageBeanComponent
org.eclnt.ccaddons.pbc.CCMultiPageContainer
All Implemented Interfaces:
Serializable, org.eclnt.jsfserver.elements.IConfiguredByLayout, org.eclnt.jsfserver.pagebean.component.IPageBeanComponent, org.eclnt.jsfserver.pagebean.IPageBean, org.eclnt.jsfserver.util.valuemgmt.IDynamicContentBindingObject
public class CCMultiPageContainer extends org.eclnt.jsfserver.pagebean.component.PageBeanComponent implements Serializable
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    CCMultiPageContainer.IListener
     
    class 
    CCMultiPageContainer.PageInfo
     

    Nested classes/interfaces inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponent

    org.eclnt.jsfserver.pagebean.component.PageBeanComponent.ILiteralResolver, org.eclnt.jsfserver.pagebean.component.PageBeanComponent.LitMap

  • Field Summary

    Fields inherited from class org.eclnt.jsfserver.pagebean.PageBean

    m_pageModifier

  • Constructor Summary

    Constructors
    Constructor
    Description
    CCMultiPageContainer()
     
    CCMultiPageContainer(boolean usedAsRow)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addPage(String url)
     
    String
    addPage(String url, String token)
     
    String
    addPage(String url, String token, String title)
     
    String
    getDefaultClosingPopupBody()
    The default closing mechanism opens up a popup when closing a page in which the user is asked if he/she really wants to close the page.
    String
    getDefaultClosingPopupTitle()
    The default closing mechanism opens up a popup when closing a page in which the user is asked if he/she really wants to close the page.
    org.eclnt.jsfserver.elements.impl.DYNAMICCONTENTBinding
    getDynContent()
    Internal usage.
    int
    getNumberOfContainedPages()
     
    List<CCMultiPageContainer.PageInfo>
    getPages()
    Internal usage.
    String
    getRootExpressionUsedInPage()
    Internal usage.
    boolean
    getTitlebarRendered()
    Internal usage.
    String
    getTitlebarStyleVariant()
     
    String
    getTitlebarText()
    Internal usage.
    boolean
    getWithDefaultClosing()
    The default close mechanism for a pages is: the user presses the close icon within the titlebar, the user gets askes if to really close and the page is removed. - You may change this behavior by setting this property to false.
    boolean
    getWithTitlebar()
     
    void
    onBeforeRendering()
     
    void
    onCloseAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)
    Internal usage.
    void
    prepare(CCMultiPageContainer.IListener listener)
     
    void
    removePage(String pageUid)
     
    void
    setDefaultClosingPopupBody(String defaultClosingPopupBody)
     
    void
    setDefaultClosingPopupTitle(String defaultClosingPopupTitle)
     
    void
    setTitlebarStyleVariant(String value)
     
    void
    setTitleOfPage(String pageUid)
     
    void
    setWithDefaultClosing(boolean withDefaultClosing)
     
    void
    setWithTitlebar(boolean value)
     
    void
    switchToPage(String pageUid)
     

    Methods inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponent

    getLit, initializePageBean, initializePageBeanConfigItems

    Methods inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase

    addConfiguredByLayoutListener, findLiteralResourceName, getClassDefiningPageBean, getLayoutPath, getLiteralResolver, getPageName, initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized, readLiteral, readLiteralByOwnResourceBundle, removeConfiguredByLayoutListener, setLiteralResolver

    Methods inherited from class org.eclnt.jsfserver.pagebean.PageBean

    buildContentReplaceString, closePopup, getActualRootExpression, getModalModelessPopupForPopupPageBean, getPageModifier, getPopups, getStamp, initializePageModifier, openModalPopup, openModelessPopup, pbx, readPageLayoutXML, setActualRootExpression

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclnt.jsfserver.elements.IConfiguredByLayout

    addConfiguredByLayoutListener, removeConfiguredByLayoutListener

    Methods inherited from interface org.eclnt.jsfserver.pagebean.IPageBean

    closePopup, getActualRootExpression, getPageModifier, getPageName, getStamp, openModalPopup, openModelessPopup, setActualRootExpression

    Methods inherited from interface org.eclnt.jsfserver.pagebean.component.IPageBeanComponent

    initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized

  • Constructor Details

    • CCMultiPageContainer

      public CCMultiPageContainer()

    • CCMultiPageContainer

      public CCMultiPageContainer(boolean usedAsRow)

  • Method Details

    • getRootExpressionUsedInPage

      public String getRootExpressionUsedInPage()
      Internal usage.
      Specified by:
      getRootExpressionUsedInPage in interface org.eclnt.jsfserver.pagebean.IPageBean
      Specified by:
      getRootExpressionUsedInPage in class org.eclnt.jsfserver.pagebean.PageBean

    • getDynContent

      public org.eclnt.jsfserver.elements.impl.DYNAMICCONTENTBinding getDynContent()
      Internal usage.

    • getPages

      public List<CCMultiPageContainer.PageInfo> getPages()
      Internal usage.

    • getTitlebarStyleVariant

      public String getTitlebarStyleVariant()

    • setTitlebarStyleVariant

      public void setTitlebarStyleVariant(String value)

    • getWithTitlebar

      public boolean getWithTitlebar()

    • setWithTitlebar

      public void setWithTitlebar(boolean value)

    • getWithDefaultClosing

      public boolean getWithDefaultClosing()
      The default close mechanism for a pages is: the user presses the close icon within the titlebar, the user gets askes if to really close and the page is removed. - You may change this behavior by setting this property to false. In this case you get notified about the user wanting to close a page (see CCMultiPageContainer.IListener) and can react accordingly.

    • setWithDefaultClosing

      public void setWithDefaultClosing(boolean withDefaultClosing)

    • getDefaultClosingPopupTitle

      public String getDefaultClosingPopupTitle()
      The default closing mechanism opens up a popup when closing a page in which the user is asked if he/she really wants to close the page. You may set some own title.

    • setDefaultClosingPopupTitle

      public void setDefaultClosingPopupTitle(String defaultClosingPopupTitle)

    • getDefaultClosingPopupBody

      public String getDefaultClosingPopupBody()
      The default closing mechanism opens up a popup when closing a page in which the user is asked if he/she really wants to close the page. You may set some own text body.

    • setDefaultClosingPopupBody

      public void setDefaultClosingPopupBody(String defaultClosingPopupBody)

    • getNumberOfContainedPages

      public int getNumberOfContainedPages()

    • getTitlebarRendered

      public boolean getTitlebarRendered()
      Internal usage.

    • getTitlebarText

      public String getTitlebarText()
      Internal usage.

    • prepare

      public void prepare(CCMultiPageContainer.IListener listener)

    • onBeforeRendering

      public void onBeforeRendering()
      Specified by:
      onBeforeRendering in interface org.eclnt.jsfserver.pagebean.IPageBean
      Overrides:
      onBeforeRendering in class org.eclnt.jsfserver.pagebean.PageBean

    • addPage

      public String addPage(String url, String token, String title)

    • addPage

      public String addPage(String url, String token)

    • addPage

      public String addPage(String url)

    • setTitleOfPage

      public void setTitleOfPage(String pageUid)

    • removePage

      public void removePage(String pageUid)

    • switchToPage

      public void switchToPage(String pageUid)

    • onCloseAction

      public void onCloseAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)
      Internal usage.