se.entra.phantom.server

Interface IDesignerControl

All Known Implementing Classes:

DesignerCCheckBox, DesignerCComboBox, DesignerCEntryField, DesignerCGroupBox, DesignerCListBox, DesignerCMLE, DesignerCNoteBook, DesignerControlAdapter, DesignerCOutputText, DesignerCPushButton, DesignerCRadioButton, DesignerCRectangle, DesignerCSpinButton, DesignerCStaticText, DesignerCTree, DesignerCUserWindow

public interface IDesignerControl

Interface to implement by the PhantomControl to create the Java component for the designer GUI from JNI.

Author:

Christopher Mindus

Method Summary

Modifier and Type	Method and Description
JComponent	createComponent(PanelDesignerControl controller, PhantomFile data, Object previousAttachment) Creates the component with the specified data.
int	getControlSBSize(PanelDesignerControl controller, int cx, int cy) Gets the size of the scroll-bar enabled part of the control.
String	getText(PanelDesignerControl controller) Gets the text of the component as possible.
boolean	isSupported(byte[] data) Checks if this data is supported.
boolean	needsImmediateCreation(byte[] data) Checks if component needs immediate creation in the Win32 thread.
void	onDestroy(PanelDesignerControl controller) Called when destroyed.
void	onImageUpdate(PanelDesignerControl controller) Called when the component needs to update its image due to change of panel font and/or background color.
int	onMouse(PanelDesignerControl controller, int operation, int x, int y) The method called from JNI.
void	onTurnPage(PanelDesignerControl controller, int page) Called when the JNI notebook turns page.
int[]	onWindowPositionChanging(PanelDesignerControl controller, int x, int y, int cx, int cy) Called by Win32 to adjust the window position before it is changed.
void	postPaint(PanelDesignerControl controller, Graphics2D g, JComponent c, int cx, int cy) Performs a post-paint.
void	prePaint(PanelDesignerControl controller, Graphics2D g, JComponent c, int cx, int cy) Performs a pre-paint.
void	setBounds(PanelDesignerControl controller, JComponent c, int x, int y, int cx, int cy) Sets the bounds of the component.
boolean	setText(PanelDesignerControl controller, String text) Sets the text of the component if possible.
boolean	wantMouseMessages() Checks if this implementor wants mouse messages.

Method Detail

isSupported

boolean isSupported(byte[] data)
             throws IOException

Checks if this data is supported.

Parameters:

data - The in-memory control data.

Returns:

true if supported, false if not.

Throws:

IOException - For file errors.

needsImmediateCreation

boolean needsImmediateCreation(byte[] data)

Checks if component needs immediate creation in the Win32 thread.

createComponent

JComponent createComponent(PanelDesignerControl controller,
                           PhantomFile data,
                           Object previousAttachment)
                    throws IOException

Creates the component with the specified data.

Parameters:

controller - The controller.

data - The in-memory control data.

previousAttachment - The previous attachment if non-null.

Returns:

The panel component.

Throws:

IOException - For file errors.

onImageUpdate

void onImageUpdate(PanelDesignerControl controller)

Called when the component needs to update its image due to change of panel font and/or background color. The font and color can be retrieved from the controller.

setBounds

void setBounds(PanelDesignerControl controller,
               JComponent c,
               int x,
               int y,
               int cx,
               int cy)

Sets the bounds of the component. This gives the opportunity for the component to change its size.

prePaint

void prePaint(PanelDesignerControl controller,
              Graphics2D g,
              JComponent c,
              int cx,
              int cy)

Performs a pre-paint.

postPaint

void postPaint(PanelDesignerControl controller,
               Graphics2D g,
               JComponent c,
               int cx,
               int cy)

Performs a post-paint.

wantMouseMessages

boolean wantMouseMessages()

Checks if this implementor wants mouse messages.

onMouse

int onMouse(PanelDesignerControl controller,
            int operation,
            int x,
            int y)

The method called from JNI.

Parameters:

controller - The controller.

operation - Mouse operation: MOUSEMOVE, BUTTONDOWN, BUTTONUP, BUTTONDBLCLK or CAPTURECHANGED.

x - Mouse position X relative the window.

y - Mouse position Y relative the window.

Returns:

One of the DO_* operations.

getControlSBSize

int getControlSBSize(PanelDesignerControl controller,
                     int cx,
                     int cy)

Gets the size of the scroll-bar enabled part of the control.

Parameters:

cx - The current width.

cy - The current height.

Returns:

-1 for default or LOWORD=width, HIWORD=height.

onWindowPositionChanging

int[] onWindowPositionChanging(PanelDesignerControl controller,
                               int x,
                               int y,
                               int cx,
                               int cy)

Called by Win32 to adjust the window position before it is changed.

Returns:

A new array of 4 [x,y,cx,cy] if changed, otherwise null.

getText

String getText(PanelDesignerControl controller)

Gets the text of the component as possible. If not possible, return null.

onTurnPage

void onTurnPage(PanelDesignerControl controller,
                int page)

Called when the JNI notebook turns page.

setText

boolean setText(PanelDesignerControl controller,
                String text)

Sets the text of the component if possible.

Returns:

true for success, false if text cannot be set.

onDestroy

void onDestroy(PanelDesignerControl controller)

Called when destroyed.