Skip to main content

Adding items to your Interactive Grid Toolbar

By
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

Post a Comment

Popular posts from this blog

apex_application.g_f0x array processing in Oracle 12

By
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 ...
Post a Comment
Read more

Filtering in the APEX Interactive Grid

By
Remember Oracle Forms? One of the nice features of Forms was the use of GLOBAL items. More or less comparable to Application Items in APEX. These GLOBALS where often used to pre-query data. For example you queried Employee 200 in Form A, then opened Form B and on opening that Form the Employee field is filled with that (GLOBAL) value of 200 and the query was executed. So without additional keys strokes or entering data, when switching to another Form a user would immediately see the data in the same context. And they loved that. In APEX you can create a similar experience using Application Items (or an Item on the Global Page) for Classic Reports (by setting a Default Value to a Search Item) and Interactive Reports (using the  APEX_IR.ADD_FILTER  procedure). But what about the Interactive Grid? There is no APEX_IG package ... so the first thing we have to figure out is how can we set a filter programmatically? Start with creating an Interactive Grid based upon the good o...
1 comment
Read more

Stop using validations for checking constraints !

By
 If you run your APEX application - like a Form based on the EMP table - and test if you can change the value of Department to something else then the standard values of 10, 20, 30 or 40, you'll get a nice error message like this: But it isn't really nice, is it? So what do a lot of developers do? They create a validation (just) in order to show a nicer, better worded, error message like "This is not a valid department".  And what you then just did is writing code twice : Once in the database as a (foreign key) check constraint and once as a sql statement in your validation. And we all know : writing code twice is usually not a good idea - and executing the same query twice is not enhancing your performance! So how can we transform that ugly error message into something nice? By combining two APEX features: the Error Handling Function and the Text Messages! Start with copying the example of an Error Handling Function from the APEX documentation. Create this function ...
Post a Comment
Read more