Package org.eclnt.ccaddons.pbc

Class CCAdaptiveSideContentArea

java.lang.Object
org.eclnt.jsfserver.pagebean.PageBean
org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase
org.eclnt.jsfserver.pagebean.component.PageBeanComponent
org.eclnt.ccaddons.pbc.CCAdaptiveSideContentArea
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 CCAdaptiveSideContentArea extends org.eclnt.jsfserver.pagebean.component.PageBeanComponent implements Serializable
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    CCAdaptiveSideContentArea.IListener
     

    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
    CCAdaptiveSideContentArea()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(CCAdaptiveSideContentArea.IListener listener)
     
    CCAdaptiveSideContentAreaButton
    createOpenerButton()
    Create an instance of the button (page bean component) that is linked to the area processing: the button is only visible when the side bean is not shown "on the left".
    org.eclnt.jsfserver.elements.util.Trigger
    getContentAnimationTrigger()
     
    String
    getContentAnimationType()
     
    org.eclnt.jsfserver.pagebean.IPageBean
    getContentBean()
    The content bean that is shown in the main content area.
    String
    getContentBorder()
     
    int
    getContentDistance()
    Sidie bean and content bean are arranged in a ROW.
    String
    getContentSize()
    Categorized size, that is passed with round trip and when the screen space of the component changes.
    int
    getCurrentHeight()
     
    int
    getCurrentWidth()
     
    String
    getExactSize()
    Exact pixel size of the component that is passed with every roundtrip.
    String
    getHorizontalCategories()
     
    org.eclnt.jsfserver.elements.util.Trigger
    getInitialRoundtripTrigger()
     
    String
    getRootExpressionUsedInPage()
     
    boolean
    getShowSideBeanAtSide()
     
    org.eclnt.jsfserver.pagebean.IPageBean
    getSideBean()
    The bean that is either shown on the left side - or that is shown as popup if screen space is not sufficient.
    String
    getSideBeanBorder()
     
    boolean
    getSideBeanRendered()
    Runtime information, if the side bean is rendered or not.
    String
    getSideBeanWidth()
     
    boolean
    getWholeRendered()
    When the component appears then first its while content is not rendered - but the component is empty.
    void
    onInitialRoundtrip(org.eclnt.jsfserver.base.faces.event.ActionEvent event)
    Method that is called directly after the component has appeared.
    void
    onSizeAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)
     
    void
    prepare(org.eclnt.jsfserver.pagebean.IPageBean sideBean, org.eclnt.jsfserver.pagebean.IPageBean contentBean, String sideBeanWidth, int minHorizontalSize, boolean showSideBeanAtSide, CCAdaptiveSideContentArea.IListener listener)
     
    void
    removeListener(CCAdaptiveSideContentArea.IListener listener)
     
    void
    setContentAnimationType(String value)
     
    void
    setContentBean(org.eclnt.jsfserver.pagebean.IPageBean contentBean)
     
    void
    setContentBorder(String value)
     
    void
    setContentDistance(int value)
     
    void
    setContentSize(String value)
     
    void
    setExactSize(String value)
     
    void
    setShowSideBeanAtSide(boolean showSideBeanAtSide)
     
    void
    setSideBeanBorder(String value)
     

    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, onBeforeRendering, 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, onBeforeRendering, openModalPopup, openModelessPopup, setActualRootExpression

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

    initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized

  • Constructor Details

    • CCAdaptiveSideContentArea

      public CCAdaptiveSideContentArea()

  • Method Details

    • getRootExpressionUsedInPage

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

    • prepare

      public void prepare(org.eclnt.jsfserver.pagebean.IPageBean sideBean, org.eclnt.jsfserver.pagebean.IPageBean contentBean, String sideBeanWidth, int minHorizontalSize, boolean showSideBeanAtSide, CCAdaptiveSideContentArea.IListener listener)
      Parameters:
      sideBean - The page bean that is either shown on the left side or which is shown as a popup.
      sideBeanWidth - Width of the side area when it is shown "on the left".
      contentBean - Content bean. Can be passed as null at the beginning and then can later be set by using method setContentBean(IPageBean).
      minHorizontalSize - The size when the rendering is changed from "popup" (below the size) to "visible" (above the size)
      showSideBeanAtSide - Force the side bean to be shown at the side - and not as popup. This is useful in initial situations in which there is no real content yet within the content bean. Pay attention: this parameter need to be set back to "false" later on - using setShowSideBeanAtSide(boolean).
      listener -

    • createOpenerButton

      public CCAdaptiveSideContentAreaButton createOpenerButton()
      Create an instance of the button (page bean component) that is linked to the area processing: the button is only visible when the side bean is not shown "on the left".

    • addListener

      public void addListener(CCAdaptiveSideContentArea.IListener listener)

    • removeListener

      public void removeListener(CCAdaptiveSideContentArea.IListener listener)

    • getContentAnimationType

      public String getContentAnimationType()

    • setContentAnimationType

      public void setContentAnimationType(String value)

    • getShowSideBeanAtSide

      public boolean getShowSideBeanAtSide()

    • setShowSideBeanAtSide

      public void setShowSideBeanAtSide(boolean showSideBeanAtSide)

    • getContentAnimationTrigger

      public org.eclnt.jsfserver.elements.util.Trigger getContentAnimationTrigger()

    • onSizeAction

      public void onSizeAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event)

    • getHorizontalCategories

      public String getHorizontalCategories()

    • getContentBean

      public org.eclnt.jsfserver.pagebean.IPageBean getContentBean()
      The content bean that is shown in the main content area.

    • setContentBean

      public void setContentBean(org.eclnt.jsfserver.pagebean.IPageBean contentBean)

    • getSideBean

      public org.eclnt.jsfserver.pagebean.IPageBean getSideBean()
      The bean that is either shown on the left side - or that is shown as popup if screen space is not sufficient.

    • getSideBeanWidth

      public String getSideBeanWidth()

    • getSideBeanRendered

      public boolean getSideBeanRendered()
      Runtime information, if the side bean is rendered or not.

    • getContentSize

      public String getContentSize()
      Categorized size, that is passed with round trip and when the screen space of the component changes.

    • setContentSize

      public void setContentSize(String value)

    • getExactSize

      public String getExactSize()
      Exact pixel size of the component that is passed with every roundtrip.

    • setExactSize

      public void setExactSize(String value)

    • getCurrentHeight

      public int getCurrentHeight()

    • getCurrentWidth

      public int getCurrentWidth()

    • getContentDistance

      public int getContentDistance()
      Sidie bean and content bean are arranged in a ROW. This is the COLDISTANCE value of this row.

    • setContentDistance

      public void setContentDistance(int value)

    • getContentBorder

      public String getContentBorder()

    • setContentBorder

      public void setContentBorder(String value)

    • getSideBeanBorder

      public String getSideBeanBorder()

    • setSideBeanBorder

      public void setSideBeanBorder(String value)

    • getInitialRoundtripTrigger

      public org.eclnt.jsfserver.elements.util.Trigger getInitialRoundtripTrigger()

    • getWholeRendered

      public boolean getWholeRendered()
      When the component appears then first its while content is not rendered - but the component is empty. Due to the getInitialRoundtripTrigger() being triggered then the component comes back to the server with its sizing so that the processing knows in which way to render.

    • onInitialRoundtrip

      public void onInitialRoundtrip(org.eclnt.jsfserver.base.faces.event.ActionEvent event)
      Method that is called directly after the component has appeared. Now the sizing of the component is transferred.