PanelDesignerControl (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.phed.PanelDesignerControl

```
public class PanelDesignerControl
extends Object
```
The PanelDesignerControl is the interface with the Panel Editor in design mode and Java GUI components to provide the real drawing as the final look will be using the Java component and not an emulation of what will be shown.

Author:

Christopher Mindus

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BUTTONDBLCLK`
`static int`	`BUTTONDOWN`
`static int`	`BUTTONUP`
`static int`	`CAPTURECHANGED`
`static int`	`DO_CAPTURE`
`static int`	`DO_COLUMN`
`static int`	`DO_EDIT_DIALOG`
`static int`	`DO_HEADER`
`static int`	`DO_NOTHING` Return codes from mouse operation, invoking operations in turn, in LOBYTE.
`static int`	`DO_PASS_MOUSE`
`static int`	`DO_RELEASE`
`static int`	`DO_TURN_PAGE`
`static int`	`EDIT_REQUEST` Mouse values.
`static int`	`MOUSEMOVE`
`static int`	`PTR_ARROW` Pointers used with `setMousePointer` method.
`static int`	`PTR_HAND`
`static int`	`PTR_MOVE`
`static int`	`PTR_SIZENESW`
`static int`	`PTR_SIZENS`
`static int`	`PTR_SIZENWSE`
`static int`	`PTR_SIZEWE`
`static int`	`PTR_TEXT`
`static int`	`PTR_WAIT`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JLabel`	`createErrorComponent(String msg)` Creates an error component.
`Object`	`getAttachment()` Gets the custom attachment.
`Color`	`getBackground(int clr)` Gets the background color of a control, if not set, the panel background.
`Color`	`getBackground(int clr, int defClr)` Gets the background color of a control, if not set, the `defClr`.
`JComponent`	`getComponent()` Gets the component.
`protected int`	`getControlSBSize(int cx, int cy)` Gets the size of the scroll-bar enabled part of the control.
`int`	`getCurrentNotebookPage()` Gets the current notebook page index.
`byte[]`	`getData()` Gets the original data.
`Font`	`getFont(int font)` Gets the font of a control, if not set, the panel font.
`static FontManager`	`getFontManager()` Gets the font manager.
`static int`	`getFontMetrics(int font, String text)` JNI method to get the font metrics.
`Color`	`getForeground(int clr, int defColor)` Gets the foreground color of a control, if not set, the second color.
`static ImageIcon`	`getImage(String fileName)` Loads an image from the runtime image path.
`static IImageManager`	`getImageManager()` Gets the Image Manager.
`static ImageIcon`	`getImageOrNull(String fileName)` Loads an image from the runtime image path.
`static double`	`getImageScale()` Gets the current image scaling factor.
`Color`	`getPanelBackground()` Gets the panel background.
`Font`	`getPanelFont()` Gets the panel font.
`protected int`	`getPreferredSize()` Gets the preferred size of the component.
`static double`	`getSynthScale()` Gets the synthetic scale for system images or sizes, used to scale checkbox/radio button images and set the combobox and spin button widths of buttons.
`protected String`	`getText()` Gets the text of the component as possible.
`int`	`getType()` Gets the type of control.
`protected void`	`invalidateWindow(long hwnd)` Invalidates the window.
`boolean`	`isComponentImageValid()` Checks if the component is valid or if it is in creation, resize or repaint state.
`boolean`	`isNewStyle()` Check if it's a new-styled panel.
`static boolean`	`isSupported(int type, byte[] data)` Checks if the type is supported in by a Java IDesignerControl implementor.
`protected void`	`onBitmapInvalidated()` Called when the Win32 bitmap is invalidated and needs to be replaced, e.g.
`protected static Object`	`onCreate(long hwnd, int type, byte[] data, int cx, int cy, int panelFont, int panelBackground, boolean isNewStyle)` Called from JNI to create the Java part of a control.
`protected void`	`onDestroy()` Called when window is destroyed.
`protected void`	`onDisplayChanged()` Called when the display has been changed (resolution, scaling, font).
`static int`	`onImage(long hwnd, int cx, int cy, int[] data, boolean needsResize)` JNI method to update the HWND with new image data.
`protected int`	`onMouse(int operation, int x, int y)` The method called from JNI when the implementation wants mouse messages.
`protected void`	`onRecreate(byte[] data)` Called to recreate the control with new data without destroying the window.
`protected void`	`onSetNewStyle(boolean on)` Sets the new style for a panel control.
`protected boolean`	`onSize(int cx, int cy, int panelFont, int panelBackground, boolean forceNewBitmap)` New size for the HWND, requires new image, trigger AWT event.
`protected boolean`	`onTurnPage(int page)` Called when the JNI notebook turns page.
`protected int[]`	`onWindowPositionChanging(int x, int y, int cx, int cy)` Called by Win32 to adjust the window position before it is changed.
`int`	`pixelHeightToDialog(int cy)` Converts a pixel height into dialog coordinates.
`int`	`pixelWidthToDialog(int cx)` Converts a pixel width into dialog coordinates.
`protected void`	`recreate(long hwnd, String oper, byte[] data)` Recreate the component with the specified data.
`void`	`recreateRepaint()` Causes the Java component to be recreated and redrawn.
`void`	`repaint()` Causes repaint of a window, including the bitmaps in the Win32 thread later...
`void`	`requestRecreate(String oper, byte[] data)` Requests recreation of the component with new data.
`void`	`setAttachment(Object o)` Sets a custom attachment.
`void`	`setInsets(Insets insets)` Sets the component insets in e.g.
`void`	`setMousePointer(int pointer)` Sets the mouse pointer.
`void`	`setNimbusStandardInsets()` Assigns the standard Nimbus insets (+2 in all directions), only if Nimbus Look-and-Feel.
`protected boolean`	`setText(String text)` Called from Win32 to set the text.
`void`	`setViewport(int x, int y, int cx, int cy)` Assigns the view port for children components when this component can contain children, e.g.
`protected void`	`setViewport(long hwnd, int x, int y, int cx, int cy)` Assigns the view port for children components when this component can contain children, e.g.
`protected void`	`setWantMouseMessages(long hwnd, boolean on)` Method call by the framework to check if the implementor wishes mouse messages or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EDIT_REQUEST
```
public static final int EDIT_REQUEST
```
    Mouse values.
    
    See Also:
    
    Constant Field Values
  - MOUSEMOVE
```
public static final int MOUSEMOVE
```
    See Also:
    
    Constant Field Values
  - BUTTONDOWN
```
public static final int BUTTONDOWN
```
    See Also:
    
    Constant Field Values
  - BUTTONUP
```
public static final int BUTTONUP
```
    See Also:
    
    Constant Field Values
  - BUTTONDBLCLK
```
public static final int BUTTONDBLCLK
```
    See Also:
    
    Constant Field Values
  - CAPTURECHANGED
```
public static final int CAPTURECHANGED
```
    See Also:
    
    Constant Field Values
  - DO_NOTHING
```
public static final int DO_NOTHING
```
    Return codes from mouse operation, invoking operations in turn, in LOBYTE. The HIBYTE can contain the index for the page or the listbox column. The HIWORD can contain a pixel or dialog unit value, e.g. for listbox column sizing. These operations can be combined. Obviously, the ones to combine are capture/release with the other actions.
    
    See Also:
    
    Constant Field Values
  - DO_CAPTURE
```
public static final int DO_CAPTURE
```
    See Also:
    
    Constant Field Values
  - DO_RELEASE
```
public static final int DO_RELEASE
```
    See Also:
    
    Constant Field Values
  - DO_EDIT_DIALOG
```
public static final int DO_EDIT_DIALOG
```
    See Also:
    
    Constant Field Values
  - DO_TURN_PAGE
```
public static final int DO_TURN_PAGE
```
    See Also:
    
    Constant Field Values
  - DO_COLUMN
```
public static final int DO_COLUMN
```
    See Also:
    
    Constant Field Values
  - DO_HEADER
```
public static final int DO_HEADER
```
    See Also:
    
    Constant Field Values
  - DO_PASS_MOUSE
```
public static final int DO_PASS_MOUSE
```
    See Also:
    
    Constant Field Values
  - PTR_ARROW
```
public static final int PTR_ARROW
```
    Pointers used with setMousePointer method.
    
    See Also:
    
    Constant Field Values
  - PTR_TEXT
```
public static final int PTR_TEXT
```
    See Also:
    
    Constant Field Values
  - PTR_WAIT
```
public static final int PTR_WAIT
```
    See Also:
    
    Constant Field Values
  - PTR_MOVE
```
public static final int PTR_MOVE
```
    See Also:
    
    Constant Field Values
  - PTR_SIZENWSE
```
public static final int PTR_SIZENWSE
```
    See Also:
    
    Constant Field Values
  - PTR_SIZENESW
```
public static final int PTR_SIZENESW
```
    See Also:
    
    Constant Field Values
  - PTR_SIZEWE
```
public static final int PTR_SIZEWE
```
    See Also:
    
    Constant Field Values
  - PTR_SIZENS
```
public static final int PTR_SIZENS
```
    See Also:
    
    Constant Field Values
  - PTR_HAND
```
public static final int PTR_HAND
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getFontManager
```
public static FontManager getFontManager()
```
    Gets the font manager.
  - getImageManager
```
public static IImageManager getImageManager()
```
    Gets the Image Manager.
  - getImageScale
```
public static double getImageScale()
```
    Gets the current image scaling factor.
    
    Returns:
    
    1.0 for no scaling, otherwise the scaling factor.
  - getImage
```
public static ImageIcon getImage(String fileName)
```
    Loads an image from the runtime image path.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    An image, with size and height -1 if not found.
  - getImageOrNull
```
public static ImageIcon getImageOrNull(String fileName)
```
    Loads an image from the runtime image path.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    An image if found, or null if not found.
  - getSynthScale
```
public static double getSynthScale()
```
    Gets the synthetic scale for system images or sizes, used to scale checkbox/radio button images and set the combobox and spin button widths of buttons.
  - getFontMetrics
```
public static int getFontMetrics(int font,
                                 String text)
```
    JNI method to get the font metrics.
    
    Parameters:
    
    font - The font.
    
    text - The text to measure, or null for character font metrics.
    
    Returns:
    
    Pixel-width of text if non-null, otherwise the LOWORD(averageCharWidth) and HIWORD(height).
  - isSupported
```
public static boolean isSupported(int type,
                                  byte[] data)
```
    Checks if the type is supported in by a Java IDesignerControl implementor.
    
    Parameters:
    
    type - The type.
    
    data - The data (null in first call).
  - onCreate
```
protected static Object onCreate(long hwnd,
                                 int type,
                                 byte[] data,
                                 int cx,
                                 int cy,
                                 int panelFont,
                                 int panelBackground,
                                 boolean isNewStyle)
```
    Called from JNI to create the Java part of a control.
  - onImage
```
public static int onImage(long hwnd,
                          int cx,
                          int cy,
                          int[] data,
                          boolean needsResize)
```
    JNI method to update the HWND with new image data.
  - onSetNewStyle
```
protected void onSetNewStyle(boolean on)
```
    Sets the new style for a panel control.
  - getData
```
public byte[] getData()
```
    Gets the original data.
  - getType
```
public int getType()
```
    Gets the type of control.
  - setAttachment
```
public void setAttachment(Object o)
```
    Sets a custom attachment.
  - getAttachment
```
public Object getAttachment()
```
    Gets the custom attachment.
  - getPanelFont
```
public Font getPanelFont()
```
    Gets the panel font.
  - getFont
```
public Font getFont(int font)
```
    Gets the font of a control, if not set, the panel font.
  - getPanelBackground
```
public Color getPanelBackground()
```
    Gets the panel background.
  - getForeground
```
public Color getForeground(int clr,
                           int defColor)
```
    Gets the foreground color of a control, if not set, the second color.
  - getBackground
```
public Color getBackground(int clr)
```
    Gets the background color of a control, if not set, the panel background.
  - getBackground
```
public Color getBackground(int clr,
                           int defClr)
```
    Gets the background color of a control, if not set, the defClr.
  - onSize
```
protected boolean onSize(int cx,
                         int cy,
                         int panelFont,
                         int panelBackground,
                         boolean forceNewBitmap)
```
    New size for the HWND, requires new image, trigger AWT event. When panel font or background changes, the AWT component must be recreated.
    
    Returns:
    
    Flag indicating if the image is being created asynchronously in the AWT thread (true) or if the image can be used now for drawing (false).
  - onDestroy
```
protected void onDestroy()
```
    Called when window is destroyed.
  - setInsets
```
public void setInsets(Insets insets)
```
    Sets the component insets in e.g. Nimbus Look-and-Feel.
    
    Parameters:
    
    insets - The insets for the component.
  - setNimbusStandardInsets
```
public void setNimbusStandardInsets()
```
    Assigns the standard Nimbus insets (+2 in all directions), only if Nimbus Look-and-Feel.
  - isComponentImageValid
```
public boolean isComponentImageValid()
```
    Checks if the component is valid or if it is in creation, resize or repaint state.
  - createErrorComponent
```
public JLabel createErrorComponent(String msg)
```
    Creates an error component.
  - getComponent
```
public JComponent getComponent()
```
    Gets the component.
  - isNewStyle
```
public boolean isNewStyle()
```
    Check if it's a new-styled panel.
  - setWantMouseMessages
```
protected void setWantMouseMessages(long hwnd,
                                    boolean on)
```
    Method call by the framework to check if the implementor wishes mouse messages or not.
  - setMousePointer
```
public void setMousePointer(int pointer)
```
    Sets the mouse pointer.
    
    Parameters:
    
    pointer - One of a PTR_* value.
  - setViewport
```
protected void setViewport(long hwnd,
                           int x,
                           int y,
                           int cx,
                           int cy)
```
    Assigns the view port for children components when this component can contain children, e.g. Sub Window and Notebook.
  - recreate
```
protected void recreate(long hwnd,
                        String oper,
                        byte[] data)
```
    Recreate the component with the specified data. This method should be called by the controller and not the implementors.
  - invalidateWindow
```
protected void invalidateWindow(long hwnd)
```
    Invalidates the window.
  - repaint
```
public void repaint()
```
    Causes repaint of a window, including the bitmaps in the Win32 thread later...
  - recreateRepaint
```
public void recreateRepaint()
```
    Causes the Java component to be recreated and redrawn.
  - onDisplayChanged
```
protected void onDisplayChanged()
```
    Called when the display has been changed (resolution, scaling, font).
  - setViewport
```
public void setViewport(int x,
                        int y,
                        int cx,
                        int cy)
```
    Assigns the view port for children components when this component can contain children, e.g. Sub Window and Notebook.
  - onMouse
```
protected int onMouse(int operation,
                      int x,
                      int y)
```
    The method called from JNI when the implementation wants mouse messages.
    
    Parameters:
    
    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
```
protected int getControlSBSize(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
```
protected int[] onWindowPositionChanging(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.
  - pixelWidthToDialog
```
public int pixelWidthToDialog(int cx)
```
    Converts a pixel width into dialog coordinates.
  - pixelHeightToDialog
```
public int pixelHeightToDialog(int cy)
```
    Converts a pixel height into dialog coordinates.
  - getText
```
protected String getText()
```
    Gets the text of the component as possible. If not possible, return null.
  - getPreferredSize
```
protected int getPreferredSize()
```
    Gets the preferred size of the component. The size is expressed in dialog units.
    
    Returns:
    
    LOWORD(width) and HIWORD(height).
  - onTurnPage
```
protected boolean onTurnPage(int page)
```
    Called when the JNI notebook turns page.
  - getCurrentNotebookPage
```
public int getCurrentNotebookPage()
```
    Gets the current notebook page index.
  - requestRecreate
```
public void requestRecreate(String oper,
                            byte[] data)
```
    Requests recreation of the component with new data. This instance will be destroyed, followed by a creation of the new component/control with a new "hwnd", etc, from the Win32 framework. Be careful with synchronization issues. Do not synchronize on "anything" to avoid dead-locks.
    
    Parameters:
    
    oper - The operation for Undo.
    
    data - The data.
  - onRecreate
```
protected void onRecreate(byte[] data)
```
    Called to recreate the control with new data without destroying the window. Typically used for the notebook.
  - onBitmapInvalidated
```
protected void onBitmapInvalidated()
```
    Called when the Win32 bitmap is invalidated and needs to be replaced, e.g. font change, new text prompt, etc.
  - setText
```
protected boolean setText(String text)
```
    Called from Win32 to set the text. This is used by the External Image.

Class PanelDesignerControl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EDIT_REQUEST

MOUSEMOVE

BUTTONDOWN

BUTTONUP

BUTTONDBLCLK

CAPTURECHANGED

DO_NOTHING

DO_CAPTURE

DO_RELEASE

DO_EDIT_DIALOG

DO_TURN_PAGE

DO_COLUMN

DO_HEADER

DO_PASS_MOUSE

PTR_ARROW

PTR_TEXT

PTR_WAIT

PTR_MOVE

PTR_SIZENWSE

PTR_SIZENESW

PTR_SIZEWE

PTR_SIZENS

PTR_HAND

Method Detail

getFontManager

getImageManager

getImageScale

getImage

getImageOrNull

getSynthScale

getFontMetrics

isSupported

onCreate

onImage

onSetNewStyle

getData

getType

setAttachment

getAttachment

getPanelFont

getFont

getPanelBackground

getForeground

getBackground

getBackground

onSize

onDestroy

setInsets

setNimbusStandardInsets

isComponentImageValid

createErrorComponent

getComponent

isNewStyle

setWantMouseMessages

setMousePointer

setViewport

recreate

invalidateWindow

repaint

recreateRepaint

onDisplayChanged

setViewport

onMouse

getControlSBSize

onWindowPositionChanging

pixelWidthToDialog

pixelHeightToDialog

getText

getPreferredSize

onTurnPage

getCurrentNotebookPage

requestRecreate

onRecreate

onBitmapInvalidated

setText