Skip to main content

Adding items to your Interactive Grid Toolbar

The APEX Interactive Grid uses the Toolbar widget to create the default Toolbar showing the Search box, Actions menu, Save button etc. And since quite a while there is a nice Plugin "Extend IG Toolbar" by Marko Goricki that makes it very easy to add additional buttons to the Toolbar.

But what if you need more than a button? 

Inspecting the contents of widget.toolbar.js, you can easily spot there can be added more to the Toolbar than just a button:
The type of control, available values:
"STATIC", "TEXT", "SELECT", "BUTTON", "MENU", "RADIO_GROUP", "TOGGLE".

The first example will show a way to easily switch from one filter to another. Of course we could use the standard functionality and create two different Report views, but using a Radio Group on the Toolbar gives a more "Tab" like user experience.

So how can we create a Radio Group that looks like a switch in the Toolbar?
In the Javascript Code property of the Interactive Grid add the code below:

function (options) {
  var tgc = options.toolbarData.toolbarFind("actions3").controls;
  // Add a Radio Group to the Toolbar
  // and define the associated action (that does the actual work)
  tgc.push(
    {
      type: "RADIO_GROUP"
      , action: "set-source"
      , id: "P855_SOURCE_SWITCH"
    });
  // Define the action : The options and what to do on change
  options.initActions = function (actions) {
    actions.add(
      {
        name: "set-source"
        , choices: [
          { label: "JOP", value: "J" }
          , { label: "Retouren", value: "R" }
        ]
        , action: function (evt, elm) { // Show the current selection
          $("input:radio[name=report_ig_toolbar_set-source]").removeClass("current");
          $("input:radio[name=report_ig_toolbar_set-source][value=" + elm.value + "]").addClass("current");
          // Set the value of the Page Item to the selected value
          $s("P855_SOURCE", elm.value);
        }
      });
  };
  return options;
}

And in our IG query we would reference P855_SOURCE (and use it in Page Items to Submit).
It will look like this (and work like a charm):

Likewise you can add a Select list with a label:

function (options) {
  var tgc = options.toolbarData.toolbarFind("actions3").controls;
  // Add Static text (as a label)
  tgc.push({
    type: "STATIC"
    , label: "Aantal maanden"
  });
  // Add Select list
  tgc.push({
    type: "SELECT"
    , action: "set-months"
    , id: "P852_TOOLBAR_MONTHS"
  });
  // Add the options and the actual action§  
  options.initActions = function (actions) {
    actions.add({
      name: "set-months",
      choices: [{ label: "1", value: "1" }
        , { label: "2", value: "2" }
        , { label: "3", value: "3" }
        , { label: "4", value: "4" }
        , { label: "5", value: "5" }
        , { label: "6", value: "6" }
        , { label: "7", value: "7" }
        , { label: "8", value: "8" }
        , { label: "9", value: "9" }
        , { label: "10", value: "10" }
        , { label: "11", value: "11" }
        , { label: "12", value: "12" }
      ],
      action: function (evt, sel) {
        // Set the Page Item to the selected value  
        var v = sel.options[sel.selectedIndex].value;
        $s("P852_MONTHS", v);
      }
    });
  };
  return options;
}

The result is looks like shown below. This gives the end user the opportunity to quickly select a number of months he would like to see in the report.


Similar, you can also add regular text fields. In this example I needed two dates (to and from) that are used in the query and another (number) field. Without this option these fields would appear in a (filter) region above the report and that wouldn't look that good (and would consume valuable screen estate).
As this is more standard than creating a (specific) select list, I made it easy for you and created a plugin that can add regular input fields and static text to the toolbar.

You can see a demo here and download it here.

Comments

Popular posts from this blog

apex_application.g_f0x array processing in Oracle 12

If you created your own "updatable reports" or your custom version of tabular forms in Oracle Application Express, you'll end up with a query that looks similar to this one:
then you disable the "Escape special characters" property and the result is an updatable multirecord form.
That was easy, right? But now we need to process the changes in the Ename column when the form is submitted, but only if the checkbox is checked. All the columns are submitted as separated arrays, named apex_application.g_f0x - where the "x" is the value of the "p_idx" parameter you specified in the apex_item calls. So we have apex_application.g_f01, g_f02 and g_f03. But then you discover APEX has the oddity that the "checkbox" array only contains values for the checked rows. Thus if you just check "Jones", the length of g_f02 is 1 and it contains only the empno of Jones - while the other two arrays will contain all (14) rows. So for processing y…

Dockerize your APEX development environment

Nowadays Docker is everywhere. It is one of the main components of Continuous Integration / Continuous Development environments. That alone indicates Docker has to be seen more as a Software Delivery Platform than as a replacement of a virtual machine.

However ...

If you are running an Oracle database using Docker on your local machine to develop some APEX application, you will probably not move that container is a whole to test and production environments. Because in that case you would not only deliver a new APEX application to the production environment - which is a good thing - but also overwrite the data in production with the data from your development environment. And that won't make your users very excited.
So in this set up you will be using Docker as a replacement of a Virtual Machine and not as a Delivery Platform.
And that's exactly the way Martin is using it as he described in this recent blog post. It is an ideal way to get up and running with an Oracle database …

Refresh selected row(s) in an Interactive Grid

In my previous post I blogged about pushing changed rows from the dabatase into an Interactive Grid. The use case I'll cover right here is probably more common - and therefore more useful!

Until we had the IG, we showed the data in a report (Interactive or Classic). Changes to the data where made by popping up a form page, making changes, saving and refreshing the report upon closing the dialog. Or by clicking an icon / button / link in your report that makes some changes to the data (like changing a status) and ... refresh the report.  That all works fine, but the downsides are: The whole dataset is returned from the server to the client - again and again. And if your pagination size is large, that does lead to more and more network traffic, more interpretation by the browser and more waiting time for the end user.The "current record" might be out of focus after the refresh, especially by larger pagination sizes, as the first rows will be shown. Or (even worse) while you…