Eloquence JDLG Plugin API Reference

Version 1.2

A C D F G I J O P R T U

A

allowRMBR() - Method in interface com.eloquence.api.Plugin

This method is deprecated since API version 1.2 and is never invoked.

apiMajorVersion() - Method in interface com.eloquence.api.Jdlg

Returns the JDLG Plugin API major version.

apiMinorVersion() - Method in interface com.eloquence.api.Jdlg

Returns the JDLG Plugin API minor version.

C

com.eloquence.api - package com.eloquence.api

consumeRightMouseButtonEvent(MouseEvent) - Method in interface com.eloquence.api.Jdlg

Consume a right mouse button event.

D

defaultKeyboardHandler(boolean) - Method in interface com.eloquence.api.Jdlg

Enables or disables the default keyboard handler.

F

fireRuleOnLosingFocus() - Method in interface com.eloquence.api.Plugin

Returns whether the plugin object triggers a rule when focus is lost.

G

getGridDimension() - Method in interface com.eloquence.api.Jdlg

Obtains the size of the Dialog raster unit.

getIntData() - Method in class com.eloquence.api.UnifiedData

Returns the contained value as int.

getKeyboardListener() - Method in interface com.eloquence.api.Jdlg

Obtains the default keyboard listener.

getStringData() - Method in class com.eloquence.api.UnifiedData

Returns the contained value as String.

I

ignoreEvent(AWTEvent) - Method in interface com.eloquence.api.Jdlg

Returns whether the specified event should be ignored.

inToolBar() - Method in interface com.eloquence.api.Jdlg

Returns whether the plugin object is located in a JDLG ToolBar.

isFocusable() - Method in interface com.eloquence.api.Plugin

Returns whether the plugin object is focusable.

isStringData() - Method in class com.eloquence.api.UnifiedData

Returns the type of the contained value.

J

Jdlg - Interface in com.eloquence.api

Plugin access to JDLG functionality.

O

obtainFocus() - Method in interface com.eloquence.api.Jdlg

Makes the plugin object obtain the focus.

onClone(Plugin) - Method in interface com.eloquence.api.Plugin

Invoked when a plugin object is derived from a model.

onCreate(Jdlg) - Method in interface com.eloquence.api.Plugin

Invoked upon plugin object creation.

onDispose() - Method in interface com.eloquence.api.Plugin

Invoked upon plugin object disposal.

onEloq2Swing() - Method in interface com.eloquence.api.Plugin

Invoked when the Eloquence program executes DLG DO or DLG DRAW.

onFocusLost() - Method in interface com.eloquence.api.Plugin

Notifies the plugin object that it has lost the focus.

onFocusReceived() - Method in interface com.eloquence.api.Plugin

Notifies the plugin object that it has received the focus.

onFontModified(Font) - Method in interface com.eloquence.api.Plugin

Notifies the plugin object that its font has been modified.

onGet(String, List) - Method in interface com.eloquence.api.Plugin

Invoked when the Eloquence program executes DLG GET.

onGetFocusPeer() - Method in interface com.eloquence.api.Plugin

Invoked to request the current focus peer object.

onRuleOverride() - Method in interface com.eloquence.api.Plugin

Returns whether the plugin object supports the RuleOverride behavior.

onSet(String, List, UnifiedData) - Method in interface com.eloquence.api.Plugin

Invoked when the Eloquence program executes DLG SET.

onSwing2Eloq() - Method in interface com.eloquence.api.Plugin

Invoked before control is passed to the Eloquence program.

onTabFocus(boolean) - Method in interface com.eloquence.api.Plugin

Notifies the plugin object that is has been tab-focused.

P

Plugin - Interface in com.eloquence.api

JDLG Plugin Interface.

processRightMouseButtonEvent(MouseEvent) - Method in interface com.eloquence.api.Jdlg

Process a right mouse button event.

R

requiresApiVersion(int, int) - Method in interface com.eloquence.api.Jdlg

Checks for a specific JDLG Plugin API version.

T

triggerRule() - Method in interface com.eloquence.api.Jdlg

Triggers the object's default rule.

triggerRule(int) - Method in interface com.eloquence.api.Jdlg

Reserved to trigger an arbitrary rule value.

U

UnifiedData - Class in com.eloquence.api

Data container to hold string or integer values.

UnifiedData(String) - Constructor for class com.eloquence.api.UnifiedData

Constructs a new UnifiedData object containing a string value.

UnifiedData(int) - Constructor for class com.eloquence.api.UnifiedData

Constructs a new UnifiedData object containing an integer value.

A C D F G I J O P R T U