com.basis.tools.guidev

Class AdvancedGBFWrapper

java.lang.Object

com.basis.tools.guidev.AdvancedGBFWrapper

public class AdvancedGBFWrapper
extends java.lang.Object

This class wraps the information contained in a .gbf file. Samples: appbuilder/ProcessEventsBuilder.src and appbuilder/LegacyPEBuilder.src. Custom generator programs generate a .src program. The AppBuilder back-end compiles a .bbj program from the generated .src program. For more information, refer to: Using Custom AppBuilder Generator Programs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AdvancedGBFWrapper.CodeBlock The CodeBlock class represents the code blocks you've added to the source node in AppBuilder IE: init, eoj, and other custom code blocks
static class	AdvancedGBFWrapper.Event The base of all events in the GBFWrapper, extended by GuiEvent, and used directly for the NonGUIEvents (Timer, and Namespace)
static class	AdvancedGBFWrapper.GuiEvent The base GUIevent class, extended by WinEvent and PopupEvent
static class	AdvancedGBFWrapper.PopupEvent This class encapsulates the PopupEvents
static class	AdvancedGBFWrapper.WinEvent This class encapsulates the TopLevel Window Events

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL
static int	FIRST
static int	NONE

Constructor Summary

Constructors

Constructor and Description
AdvancedGBFWrapper(GUIBuilder p_gui) One of these is passed into ProcessEventsBuilder.src.

Method Summary

Modifier and Type	Method and Description
AdvancedGBFWrapper.CodeBlock	getCodeBlock(java.lang.String p_label) This returns only code blocks which would hang under the Source Node.
BBjVector	getCodeBlocks()
BBjVector	getEventsForPopup(java.lang.String p_str) Returns a Vector of AdvancedGBFWrapper#PopupEvent which must be registered
BBjVector	getEventsForTopLevelWindow(java.lang.String p_str) Returns a Vector of AdvancedGBFWrapper#WinEvent which must be registered
BBjVector	getNonGUIEvents() Returns a list of Events which are not tied to a Gui Object, ie: timers and namespaces
BBjVector	getPopupMenuList() List of TLI's for PopupMenus for which events must be registered
java.lang.String	getProperty(java.lang.String p_prop)
java.lang.String[]	getPropertyList()
BBjVector	getTopLevelWindowList() List of TLI's for the TopLevelWindows for which events must be registered
int	initNoneFirstAll()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

See Also:

Constant Field Values

FIRST

public static final int FIRST

See Also:

Constant Field Values

ALL

public static final int ALL

See Also:

Constant Field Values

Constructor Detail

AdvancedGBFWrapper

public AdvancedGBFWrapper(GUIBuilder p_gui)
                   throws BBjException

One of these is passed into ProcessEventsBuilder.src. You should not have to build one of these by hand, but for packaging reasons, the constructor must be public.

Throws:

BBjException

Method Detail

initNoneFirstAll

public int initNoneFirstAll()
                     throws BBjException

Returns:

Which windows to init at startup: (0=none, 1=first, 2=all)

Throws:

BBjException

getProperty

public java.lang.String getProperty(java.lang.String p_prop)
                             throws BBjException

Returns:

the propery as specified in the header of the .gbf file. throws ARG_ERR if no property

Throws:

BBjException

getPropertyList

public java.lang.String[] getPropertyList()

Returns:

a String array of the properties defined in the .gbf file.

getTopLevelWindowList

public BBjVector getTopLevelWindowList()

List of TLI's for the TopLevelWindows for which events must be registered

getPopupMenuList

public BBjVector getPopupMenuList()

List of TLI's for PopupMenus for which events must be registered

getNonGUIEvents

public BBjVector getNonGUIEvents()

Returns a list of Events which are not tied to a Gui Object, ie: timers and namespaces

getEventsForPopup

public BBjVector getEventsForPopup(java.lang.String p_str)
                            throws BBjException

Returns a Vector of AdvancedGBFWrapper#PopupEvent which must be registered

Throws:

BBjException

getEventsForTopLevelWindow

public BBjVector getEventsForTopLevelWindow(java.lang.String p_str)
                                     throws BBjException

Returns a Vector of AdvancedGBFWrapper#WinEvent which must be registered

Throws:

BBjException

getCodeBlocks

public BBjVector getCodeBlocks()

Returns:

The CodeBlocks defined in the .gbf

getCodeBlock

public AdvancedGBFWrapper.CodeBlock getCodeBlock(java.lang.String p_label)
                                          throws BBjException

This returns only code blocks which would hang under the Source Node. IT will not return WinEvents or PopupEvents.

Returns:

the CodeBlock for the @param p_label

Throws:

BBjException.ARG_ERR - if p_label does not resolve to an existing CodeBlock

BBjException