CREATE WIDGET-POOL statement

Creates a named or unnamed widget pool in which to contain most dynamic widgets and other handle-based objects created during an ABL session.

Syntax

CREATE WIDGET-POOL
  [ pool-name [ PERSISTENT ] ]
  [ NO-ERROR ]

pool-name

A character-string expression that specifies the name for a named widget pool you are creating. Widget pool names are not case sensitive.

If you omit this option, an unnamed widget pool is created and scoped to the procedure or class-based method. That is, a routine-scoped unnamed widget pool and its contents remain in effect as long as the procedure or method is on the call stack, and the pool and its contents are automatically deleted when the procedure or method is removed from the call stack.

PERSISTENT

Specifies that the named widget pool is persistent. This means that the pool and any widgets in it remain allocated after the current procedure or method terminates. If you do not specify this option, the pool and its contents are automatically deleted when procedure or method execution ends.

NO-ERROR

The NO-ERROR option is used to prevent the statement from raising ERROR and displaying error messages.

Example

The following example lets you create a series of dynamic buttons. All the buttons are created within a named widget pool. Because the widget pool is created within a trigger, it is defined as persistent so that it remains allocated after the trigger ends. You can at any time choose to delete the entire widget pool and start over.

r-widpl.p

DEFINE VARIABLE wh AS HANDLE NO-UNDO.

DEFINE BUTTON b_create LABEL "Create Button".
DEFINE BUTTON b_del    LABEL "Delete Buttons".
DEFINE BUTTON b_quit LABEL "Quit"
  TRIGGERS:
    ON CHOOSE DO:
      IF VALID-HANDLE(wh) THEN
        DELETE WIDGET-POOL "new-buttons".
      QUIT.
    END.
  END.
  
DEFINE FRAME butt-frame
  b_create b_del b_quit
  WITH ROW SCREEN-LINES - 2.
  
DEFINE FRAME new-buttons
  WITH SIZE 76 BY 11 CENTERED ROW 2 TITLE "New Buttons".

ON CHOOSE OF b_create IN FRAME butt-frame DO:
  STATUS INPUT "Press RETURN to select a new button".
  IF wh = ? OR NOT VALID-HANDLE(wh) THEN
    CREATE WIDGET-POOL "new-buttons" PERSISTENT.
  CREATE BUTTON wh IN WIDGET-POOL "new-buttons" ASSIGN
    FRAME     = FRAME new-buttons:HANDLE
    ROW       = RANDOM(2, 9)
    COLUMN    = RANDOM(2, 58)
    LABEL     = "BUTTON " + STRING(ETIME)
    SENSITIVE = TRUE
    VISIBLE   = TRUE
    TRIGGERS:
      ON CHOOSE PERSISTENT RUN dispmsg.
    END.
END.

ON CHOOSE OF b_del IN FRAME butt-frame DO:
  IF VALID-HANDLE(wh) THEN
    DELETE WIDGET-POOL "new-buttons".
  STATUS INPUT. 
END.

ENABLE b_create b_del b_quit WITH FRAME butt-frame.

DO ON ENDKEY UNDO, LEAVE:
  WAIT-FOR CHOOSE OF b_quit IN FRAME butt-frame.
END.

IF VALID-HANDLE(wh) THEN 
  DELETE WIDGET-POOL "new-buttons".

PROCEDURE dispmsg:
  MESSAGE "You chose button " SELF:LABEL.
END PROCEDURE.

Notes

• The AVM automatically creates a persistent unnamed widget pool (session widget pool) at the start of each session. Most applications use only this session widget pool.
• In general, unnamed widget pools cannot persist beyond the scope of the procedure or method in which they are created, except the session widget pool, which is created by the AVM.
• If you create an unnamed widget pool in the main block of a persistent procedure or you instantiate a class where the USE-WIDGET-POOL option is defined somewhere in its hierarchy, the AVM creates an object-persistent unnamed widget pool that persists for the lifetime of the persistent procedure or class-based object, respectively. This object-persistent widget pool then becomes the default widget pool for any internal procedure of the persistent procedure or any method of the instantiated class that is invoked from outside the respective persistent procedure or instantiated class. However, any routine-scoped unnamed widget pool created by these internal procedures or methods supersedes this object-persistent widget pool. For more information on the USE-WIDGET-POOL option, see the CLASS statement reference entry.
• When you create an unnamed widget pool, it automatically becomes the default widget pool. Each subsequent dynamically created widget is placed in this unnamed pool unless you specifically assign it to another pool. This unnamed pool remains the default widget pool until it is deleted or you create another unnamed widget pool. Thus, if you create no unnamed widget pools, all dynamically created widgets go into the session widget pool, unless assigned to another pool. If you create any additional unnamed widget pools, either object-persistent or routine-scoped, the most locally scoped and recently created unnamed widget pool becomes the default widget pool for all subsequently created dynamic widgets.
• Persistent widget pools remain allocated until they are explicitly deleted (with the DELETE WIDGET-POOL statement) or until the end of the ABL session that created them.
• All named widget pools are globally scoped. While a named widget pool is allocated, any procedure within the same process can access that widget pool. The name of a widget pool must be unique among all widget pools for the process. If you try to create a widget pool with the same name as an existing pool, the AVM raises the ERROR condition.
• If a recursive procedure or method creates an unnamed widget pool, each iteration of that procedure or method creates a separate pool. If a recursive routine creates a named widget pool, you must ensure that only one iteration creates the pool (where all iterations can share it) or use a different name in each iteration (where each creates and uses its own pool).
• You might want to create a new, unnamed widget pool just before invoking a new procedure or method and then delete that pool when the procedure or method returns. This ensures that any dynamic widgets created by that procedure or method in the default pool are deleted immediately. For example:

  CREATE WIDGET-POOL. RUN xyz.p. DELETE WIDGET-POOL.

  Similarly, you might want to store all dynamic widgets for a subsystem within a specific named pool. For example:

  CREATE WIDGET-POOL "oe-pool". RUN ord-ent.p DELETE WIDGET-POOL "oe-pool".

  In this example, the procedure ord-ent.p must reference the oe-pool for each dynamic widget it creates.

See also

CLASS statement, CREATE widget statement, DELETE WIDGET-POOL statement, NO-ERROR option