ICEfaces
  1. ICEfaces
  2. ICE-9485

ICEfaces Showcase, some demo Java Source Code files map to the wrong files

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 3.2
    • Fix Version/s: EE-3.3.0.GA_P01, 4.0.BETA, 4.0
    • Component/s: Sample Apps
    • Labels:
      None
    • Environment:
      ICEfaces 3.x, ICEfaces Showcase sample application
    • Assignee Priority:
      P2
    • Affects:
      Sample App./Tutorial

      Description

      The ICEfaces Showcase (icefaces/samples/showcase) application provides a feature whereby the source code files for each demo can be viewed in a tabPane at the bottom of the demo page.

      In certain demos, it has been noted that the Java source files shown for the demo are actually the source files used to create the demo entry in the structure of the application menu, and not the Bean Java source code that is intended to be shown with the demo.

      One example of this is the ace:menuBar -> Dynamic demo, the incorrect Java source file that is provided is MenuBarDynamic.java, where the correct Java source file that should be shown is MenuBarBean.java

      Other examples of this problem exist in showcase, so the first step is to audit each demo and note in this JIRA which demos have issues and need to be corrected.
       

        Activity

        Hide
        Cruz Miraback added a comment - - edited

        I've analyzed the displayed source code tabs for all of the ACE components in Showcase (icefaces3/trunk revision# 37292) and found multiple instances of the wrong source code being displayed, as well as some other issues.

        1) The following demos are displaying the Java source code used to create the demo entry in the structure of the application menu, and not the Java source code that is intended to be shown with the demo:

        ace:checkboxButton > Custom Style
        CheckboxButtonCustomBean.java should be replaced with CheckboxButtonBean.java.

        ace:contextMenu > Table Integration:
        ContextMenuTable.java should be replaced with DataTableDynamic.java

        ace:dataTable > Multi Row Header:
        DataTableColumnResizing.java should be replaced with DataTableMultiRowHeader.java (title in the tabPane says DataTableMultiRowHeader.java but the actual java source is DataTableColumnResizing.java).

        ace:dataTable > Sorting:
        DataTableSorting.java should be replaced with DataTableSort.java

        ace:list > Complex Block Object:
        ListBlockComplexBean.java should be replaced with ListBean.java

        ace:menuBar > Dynamic:
        MenuBarDynamic.java should be replaced with MenuDynamic.java

        -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

        2) The following demos don't use a bean in the example code (except in the ui:params for generating the title, description, etc..) but the bean is being displayed anyway:

        ace:accordion > Toggle Effect:
        AccordionPanelEffect.java should be removed.

        ace:animation > Overview:
        AnimationBean.java should be removed.

        ace:confirmationDialog > Modal:
        ConfirmationDialogModal.java should be removed.

        ace:contextMenu > Overview:
        ContextMenuBean.java should be removed.

        ace:contextMenu > Multi Column:
        ContextMenuMultiColumn.java should be removed.

        ace:gMap > Google Events:
        MapEventBean.java should be removed.

        ace:menu > As Popup:
        MenuDisplay.java should be removed.

        ace:menuBar > Multi Column:
        MenuBarMultiColumn.java should be removed.

        ace:notificationPanel > Client Side:
        NotificationPanelClient.java should be removed.

        ace:panel > Menu:
        PanelMenu.java should be removed.

        ace:progressBar > Client Side:
        ProgressBarClient.java should be removed.

        ace:resizable > Overview:
        ResizableBean.java should be removed.

        ace:tabSet > Client Side:
        TabClientSideBean.java should be removed.

        ace:tooltip > Global:
        GlobalTooltipBean.java should be removed.

        -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

        3) The following demos are using beans that are not currently being displayed in a source code tabPane. Some of these may have been intentionally left out:

        ace:autoCompleteEntry > Select Items, Match Criteria, Displayed Rows, Required Styling:
        AutoCompleteEntryBean.java is not being displayed (used in f:selectItems of the autoCompleteEntry).

        ace:autoCompleteEntry > Label Position, Indicator Text
        AutoCompleteEntryBean.java is not being displayed (used in f:selectItems of the autoCompleteEntry).
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:comboBox > Label Position, Indicator Text
        ComboBoxBean.java is not being displayed (used multiple times on the page).
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:comboBox > Required Styling:
        ComboBoxBean.java is not being displayed (used multiple times on the page).

        ace:contextMenu > Delegate:
        DataTableDynamic.java is not being displayed (used to populate the dataTable).

        ace:dataExporter > Overview, Specify Columns:
        DataTableSort.java is not being displayed (used to populate the dataTable).

        ace:dataTable > Click Events:
        DataTableBean.java is not being displayed (used to populate the dataTable).

        ace:dataTable > Find, Grouping, Row State, Selection:
        DataTableBindings.java is not being displayed (used in binding of dataTable).

        ace:dateTimeEntry > Label Position, Indicator Text:
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:maskedEntry > Label Position, Indicator Text:
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:selectMenu > Label Position, Indicator Text:
        SelectMenuBean.java is not being displayed (used multiple times on the page).
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:selectMenu > Required Styling:
        SelectMenuBean.java is not being displayed (used multiple times on the page).

        ace:simpleSelectOneMenu > Label Position, Required Styling:
        SimpleSelectOneMenuBean.java is not being displayed (used multiple times on the page).

        ace:simpleSelectOneMenu > Indicator Text:
        SimpleSelectOneMenuBean.java is not being displayed (used multiple times on the page).
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:textEntry > Label Position, Indicator Text:
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:textAreaEntry > Label Position, Indicator Text:
        PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu).

        ace:tooltip > Delegate
        DataTableSort.java is not being displayed (used to populate the dataTable).

        -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

        4) Incorrect bean title:

        ace:list > Selection:
        The bean being displayed is correct but the title in the tabPane is not (title 'ListReorderBean.java' should be replaced with 'ListSelectionBean.java').

        Show
        Cruz Miraback added a comment - - edited I've analyzed the displayed source code tabs for all of the ACE components in Showcase (icefaces3/trunk revision# 37292) and found multiple instances of the wrong source code being displayed, as well as some other issues. 1) The following demos are displaying the Java source code used to create the demo entry in the structure of the application menu, and not the Java source code that is intended to be shown with the demo: ace:checkboxButton > Custom Style CheckboxButtonCustomBean.java should be replaced with CheckboxButtonBean.java. ace:contextMenu > Table Integration: ContextMenuTable.java should be replaced with DataTableDynamic.java ace:dataTable > Multi Row Header: DataTableColumnResizing.java should be replaced with DataTableMultiRowHeader.java (title in the tabPane says DataTableMultiRowHeader.java but the actual java source is DataTableColumnResizing.java). ace:dataTable > Sorting: DataTableSorting.java should be replaced with DataTableSort.java ace:list > Complex Block Object: ListBlockComplexBean.java should be replaced with ListBean.java ace:menuBar > Dynamic: MenuBarDynamic.java should be replaced with MenuDynamic.java ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 2) The following demos don't use a bean in the example code (except in the ui:params for generating the title, description, etc..) but the bean is being displayed anyway: ace:accordion > Toggle Effect: AccordionPanelEffect.java should be removed. ace:animation > Overview: AnimationBean.java should be removed. ace:confirmationDialog > Modal: ConfirmationDialogModal.java should be removed. ace:contextMenu > Overview: ContextMenuBean.java should be removed. ace:contextMenu > Multi Column: ContextMenuMultiColumn.java should be removed. ace:gMap > Google Events: MapEventBean.java should be removed. ace:menu > As Popup: MenuDisplay.java should be removed. ace:menuBar > Multi Column: MenuBarMultiColumn.java should be removed. ace:notificationPanel > Client Side: NotificationPanelClient.java should be removed. ace:panel > Menu: PanelMenu.java should be removed. ace:progressBar > Client Side: ProgressBarClient.java should be removed. ace:resizable > Overview: ResizableBean.java should be removed. ace:tabSet > Client Side: TabClientSideBean.java should be removed. ace:tooltip > Global: GlobalTooltipBean.java should be removed. ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 3) The following demos are using beans that are not currently being displayed in a source code tabPane. Some of these may have been intentionally left out: ace:autoCompleteEntry > Select Items, Match Criteria, Displayed Rows, Required Styling: AutoCompleteEntryBean.java is not being displayed (used in f:selectItems of the autoCompleteEntry). ace:autoCompleteEntry > Label Position, Indicator Text AutoCompleteEntryBean.java is not being displayed (used in f:selectItems of the autoCompleteEntry). PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:comboBox > Label Position, Indicator Text ComboBoxBean.java is not being displayed (used multiple times on the page). PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:comboBox > Required Styling: ComboBoxBean.java is not being displayed (used multiple times on the page). ace:contextMenu > Delegate: DataTableDynamic.java is not being displayed (used to populate the dataTable). ace:dataExporter > Overview, Specify Columns: DataTableSort.java is not being displayed (used to populate the dataTable). ace:dataTable > Click Events: DataTableBean.java is not being displayed (used to populate the dataTable). ace:dataTable > Find, Grouping, Row State, Selection: DataTableBindings.java is not being displayed (used in binding of dataTable). ace:dateTimeEntry > Label Position, Indicator Text: PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:maskedEntry > Label Position, Indicator Text: PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:selectMenu > Label Position, Indicator Text: SelectMenuBean.java is not being displayed (used multiple times on the page). PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:selectMenu > Required Styling: SelectMenuBean.java is not being displayed (used multiple times on the page). ace:simpleSelectOneMenu > Label Position, Required Styling: SimpleSelectOneMenuBean.java is not being displayed (used multiple times on the page). ace:simpleSelectOneMenu > Indicator Text: SimpleSelectOneMenuBean.java is not being displayed (used multiple times on the page). PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:textEntry > Label Position, Indicator Text: PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:textAreaEntry > Label Position, Indicator Text: PositionBean.java is not being displayed (used in f:selectItems of the simpleSelectOneMenu). ace:tooltip > Delegate DataTableSort.java is not being displayed (used to populate the dataTable). ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 4) Incorrect bean title: ace:list > Selection: The bean being displayed is correct but the title in the tabPane is not (title 'ListReorderBean.java' should be replaced with 'ListSelectionBean.java').
        Hide
        Cruz Miraback added a comment -

        Items 1) and 4) have been fixed.

        Committed to icefaces3/trunk at revision# 37316
        Committed to icefaces-ee-3.3.0.GA_P01/icefaces at revision# 37318

        Show
        Cruz Miraback added a comment - Items 1) and 4) have been fixed. Committed to icefaces3/trunk at revision# 37316 Committed to icefaces-ee-3.3.0.GA_P01/icefaces at revision# 37318
        Hide
        Cruz Miraback added a comment -

        For item 2), do we want to remove the beans and display only the facelets page in the source code tabs?

        For item 3), which missing beans do we want to add to the source code tabs of the demos, if any?

        Show
        Cruz Miraback added a comment - For item 2), do we want to remove the beans and display only the facelets page in the source code tabs? For item 3), which missing beans do we want to add to the source code tabs of the demos, if any?
        Hide
        Mark Collette added a comment -

        For #2, if there are no EL expressions to any beans, except just the ui:param for the strings, then yes, let's remove the bean references.

        For #3, if there are beans to add, it would just be what the EL expressions reference for using data models, method expressions or value expressions for properties.

        Show
        Mark Collette added a comment - For #2, if there are no EL expressions to any beans, except just the ui:param for the strings, then yes, let's remove the bean references. For #3, if there are beans to add, it would just be what the EL expressions reference for using data models, method expressions or value expressions for properties.
        Hide
        Cruz Miraback added a comment -

        #2 has been fixed.

        icefaces3/trunk at revision# 37365
        icefaces-ee.3.3.0.GA_P01/icefaces at revision# 37367

        Show
        Cruz Miraback added a comment - #2 has been fixed. icefaces3/trunk at revision# 37365 icefaces-ee.3.3.0.GA_P01/icefaces at revision# 37367
        Hide
        Ken Fyten added a comment -

        Another solution would be to leave the filenames intact but just change the title in the source code tabPane. For instance, the file being displayed would be TextEntryLabelBean.java but the title of the tabPane could be LabelBean.java. When clicking on the tab to display the source code the full file name would be displayed at the top (in the gray box).

        This would be acceptable if we modified the title strings to use "..." at the beginning or end of the name where it was truncated to indicate that the complete name was not being rendered. So for example, "TextEntryLabelBean.java" would become "...LabelBean.java" in the title.

        Show
        Ken Fyten added a comment - Another solution would be to leave the filenames intact but just change the title in the source code tabPane. For instance, the file being displayed would be TextEntryLabelBean.java but the title of the tabPane could be LabelBean.java. When clicking on the tab to display the source code the full file name would be displayed at the top (in the gray box). This would be acceptable if we modified the title strings to use "..." at the beginning or end of the name where it was truncated to indicate that the complete name was not being rendered. So for example, "TextEntryLabelBean.java" would become "...LabelBean.java" in the title.
        Hide
        Cruz Miraback added a comment -

        #3 has been fixed.

        Utility beans that were not crucial to understanding the demo source were not added to the source code tabs, this includes PositionBean.java and DataTableBindings.java. The component name in the filename of any tabPane titles that caused wrapping were replaced with "..." to indicate that the complete name was not being shown. The only component demos that required this change were AutoCompleteEntry and SimpleSelectOneMenu.

        icefaces3/trunk at revision# 37375
        icefaces-ee.3.3.0.GA_P01/icefaces at revision# 37376

        Show
        Cruz Miraback added a comment - #3 has been fixed. Utility beans that were not crucial to understanding the demo source were not added to the source code tabs, this includes PositionBean.java and DataTableBindings.java. The component name in the filename of any tabPane titles that caused wrapping were replaced with "..." to indicate that the complete name was not being shown. The only component demos that required this change were AutoCompleteEntry and SimpleSelectOneMenu. icefaces3/trunk at revision# 37375 icefaces-ee.3.3.0.GA_P01/icefaces at revision# 37376

          People

          • Assignee:
            Cruz Miraback
            Reporter:
            Ken Fyten
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: