Package com.basis.tools.guidev

Class AdvancedGBFWrapper

java.lang.Object

com.basis.tools.guidev.AdvancedGBFWrapper

public class AdvancedGBFWrapper
extends 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	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	Description
static final int	ALL
static final int	FIRST
static final int	NONE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

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 Details

AdvancedGBFWrapper

public AdvancedGBFWrapper(com.basis.util.GUIBuilder p_gui)
                   throws com.basis.startup.type.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:

com.basis.startup.type.BBjException

Method Details

initNoneFirstAll

public int initNoneFirstAll()
                     throws com.basis.startup.type.BBjException

Returns:

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

Throws:

com.basis.startup.type.BBjException

getProperty

public String getProperty(String p_prop)
                   throws com.basis.startup.type.BBjException

Returns:

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

Throws:

com.basis.startup.type.BBjException

getPropertyList

public String[] getPropertyList()

Returns:

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

getTopLevelWindowList

public com.basis.startup.type.BBjVector getTopLevelWindowList()

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

getPopupMenuList

public com.basis.startup.type.BBjVector getPopupMenuList()

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

getNonGUIEvents

public com.basis.startup.type.BBjVector getNonGUIEvents()

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

getEventsForPopup

public com.basis.startup.type.BBjVector getEventsForPopup(String p_str)
                                                   throws com.basis.startup.type.BBjException

Returns a Vector of AdvancedGBFWrapper#PopupEvent which must be registered

Throws:

com.basis.startup.type.BBjException

getEventsForTopLevelWindow

public com.basis.startup.type.BBjVector getEventsForTopLevelWindow(String p_str)
                                                            throws com.basis.startup.type.BBjException

Returns a Vector of AdvancedGBFWrapper#WinEvent which must be registered

Throws:

com.basis.startup.type.BBjException

getCodeBlocks

public com.basis.startup.type.BBjVector getCodeBlocks()

Returns:

The CodeBlocks defined in the .gbf

getCodeBlock

public AdvancedGBFWrapper.CodeBlock getCodeBlock(String p_label)
                                          throws com.basis.startup.type.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:

com.basis.startup.type.BBjException - with ARG_ERR if p_label does not resolve to an existing CodeBlock