PPanel (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.client.PPanel

All Implemented Interfaces:

VetoableChangeListener, Runnable, EventListener, CloseWindow
```
public class PPanel
extends Object
implements CloseWindow, Runnable, VetoableChangeListener
```
This class handles a Phantom panel. The panel can be of application panel type, main panel or pop-up panel.
The panel is physically created and all GUI events are processed. Update transactions from the server is also handled here. Control events may result in a Client Updated transaction to the server.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isApplicationPanel` This flag is true if this is the application panel (MDI frame).
`protected boolean`	`isMainPanel` This flag indicates the panel is a main panel.
`protected Container`	`panelFrame` The frame component of this panel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKeyPressedListener(KeyPressedListener listener)` Adds a listener for pressed keys.
`void`	`copyPanel(boolean asImage)` Copies the entire panel to the clipboard, optionally as an image.
`int`	`getAverageCharWidth()` Gets the average font width for the panel in the panel font.
`JPanel`	`getBarContainer()` Gets the bar container panel.
`Container`	`getContainer()` Gets the panel area container.
`PControl`	`getControl(Component c)` Gets the control in the panel from a Component.
`PControl`	`getControl(int index)` Gets the control of a certain index in the panel.
`PControl`	`getControl(String controlID)` Gets the control of the specified "controlID".
`int`	`getControlCount()` Gets the control count.
`int`	`getControlIndex(Component c)` Gets the control index in the panel from a Component.
`int`	`getFontHeight()` Get font height.
`Container`	`getFrame()` Gets the frame window of the panel.
`int`	`getHeight()` The height of this panel.
`ArrayList<ImageIcon>`	`getIcons()` Get the defined icon images for this panel.
`PMenu`	`getMenu()` Gets the menu bar instance.
`Component`	`getMostRecentFocusOwner()` Gets the most recent focus component for a JInternalFrame or a JDialog, only for JDK 1.4 (null is returned for other platforms).
`static PPanel`	`getPanelFromComponent(Component c)` Gets a panel from a component.
`String`	`getPanelID()` Gets the panel ID assigned to this panel, valid also for notebook pages.
`int`	`getPanelIndex()` Gets the panel index (0=main panel, 1=first pop-up,...).
`Phantom`	`getPhantomApplet()` Gets the reference to the Phantom instance (applet).
`SessionManager.Session`	`getSession()` Gets the panel session of this panel.
`SessionManager`	`getSessionManager()` Gets the session manager reference.
`int`	`getWidth()` The width of this panel.
`boolean`	`hasIDs()` Checks if the panel uses ID's for control and the panel itself.
`boolean`	`isApplicationPanel()` Access is panel an application panel.
`boolean`	`isChild()` Checks if this panel is a child window inside an application panel.
`boolean`	`isCreateInProgress()` Checks if the create process is in progress.
`boolean`	`isDisposeInProgress()` Is dispose in progress flag.
`boolean`	`isEnabled()` Checks if this panel is enabled.
`boolean`	`isMainPanel()` Checks if this panel is of main panel type.
`boolean`	`isNoteBookPage()` Checks if the panel is a notebook page.
`boolean`	`isPanelLocked()` Checks if a panel is locked.
`boolean`	`issueActionEvent(AEvent ae)` Issue action event to server.
`void`	`issueUpdate(AEvent ae, Transaction trans)` Issue update for all controls (NoteBook will result in recursive call).
`void`	`onCloseWindow()` Closes the frame or the internal frame.
`void`	`removeKeyPressedListener(KeyPressedListener listener)` Removes a listener for pressed keys.
`boolean`	`requestDefaultFocus()` Requests the default focus.
`boolean`	`resetDefaultFocus()` Reset to default focus.
`void`	`run()` Method to send changes of current selection to the server.
`void`	`setDocked()` Flags panel as docked.
`void`	`setEnabled(boolean b)` Changes the enabled state for this panel.
`void`	`setPanelLock(boolean lock)` Sets the panel lock.
`void`	`vetoableChange(PropertyChangeEvent e)` Checks for maximize property being set on pop-up panels that can't be maximized.

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

- Field Detail
  - isMainPanel
```
protected boolean isMainPanel
```
    This flag indicates the panel is a main panel.
  - isApplicationPanel
```
protected boolean isApplicationPanel
```
    This flag is true if this is the application panel (MDI frame).
  - panelFrame
```
protected Container panelFrame
```
    The frame component of this panel.
- Method Detail
  - hasIDs
```
public boolean hasIDs()
```
    Checks if the panel uses ID's for control and the panel itself.
  - getPanelID
```
public String getPanelID()
```
    Gets the panel ID assigned to this panel, valid also for notebook pages. The panel ID is "null" if extended create information is not set, or has not yet been set during panel creation.
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Gets the session manager reference.
  - getPhantomApplet
```
public Phantom getPhantomApplet()
```
    Gets the reference to the Phantom instance (applet).
  - getSession
```
public SessionManager.Session getSession()
```
    Gets the panel session of this panel.
    
    Returns:
    
    null if this panel is the application panel.
  - getPanelIndex
```
public int getPanelIndex()
```
    Gets the panel index (0=main panel, 1=first pop-up,...).
  - isApplicationPanel
```
public boolean isApplicationPanel()
```
    Access is panel an application panel.
  - isDisposeInProgress
```
public boolean isDisposeInProgress()
```
    Is dispose in progress flag.
  - isCreateInProgress
```
public boolean isCreateInProgress()
```
    Checks if the create process is in progress.
    
    Returns:
    
    true if the create process is in progress, false otherwise.
  - resetDefaultFocus
```
public boolean resetDefaultFocus()
```
    Reset to default focus.
    
    Returns:
    
    true if it managed.
  - getMostRecentFocusOwner
```
public Component getMostRecentFocusOwner()
```
    Gets the most recent focus component for a JInternalFrame or a JDialog, only for JDK 1.4 (null is returned for other platforms).
  - requestDefaultFocus
```
public boolean requestDefaultFocus()
```
    Requests the default focus. The focus will be set to the first focusable component using grabFocus.
  - isEnabled
```
public boolean isEnabled()
```
    Checks if this panel is enabled.
  - setEnabled
```
public void setEnabled(boolean b)
```
    Changes the enabled state for this panel.
  - isPanelLocked
```
public boolean isPanelLocked()
```
    Checks if a panel is locked. The session manager is first checked for a session lock, then if if session lock is not set, the panel lock state or panel disabled state is returned.
  - setPanelLock
```
public void setPanelLock(boolean lock)
```
    Sets the panel lock.
  - getPanelFromComponent
```
public static PPanel getPanelFromComponent(Component c)
```
    Gets a panel from a component.
    
    Returns:
    
    null if not found.
  - isChild
```
public boolean isChild()
```
    Checks if this panel is a child window inside an application panel.
  - isNoteBookPage
```
public boolean isNoteBookPage()
```
    Checks if the panel is a notebook page.
  - getMenu
```
public PMenu getMenu()
```
    Gets the menu bar instance.
  - isMainPanel
```
public boolean isMainPanel()
```
    Checks if this panel is of main panel type.
  - getFrame
```
public Container getFrame()
```
    Gets the frame window of the panel. This can be either a JFrame, JDialog or a PJInternalFrame instance. In the Frameless case, JApplet might be returned.
    If the call is done to the notebook container, the frame of the notebook is returned.
  - getIcons
```
public ArrayList<ImageIcon> getIcons()
```
    Get the defined icon images for this panel.
    
    Returns:
    
    Array of icon images
  - getContainer
```
public Container getContainer()
```
    Gets the panel area container.
  - getBarContainer
```
public JPanel getBarContainer()
```
    Gets the bar container panel. The toolbar is added at the top, the status bar at the bottom and the panel area is at the center.
  - getControlCount
```
public int getControlCount()
```
    Gets the control count.
  - getControl
```
public PControl getControl(int index)
```
    Gets the control of a certain index in the panel.
  - getControl
```
public PControl getControl(String controlID)
```
    Gets the control of the specified "controlID".
    
    Returns:
    
    null if not found or extended create information is not present for the panel.
  - getControl
```
public PControl getControl(Component c)
```
    Gets the control in the panel from a Component.
    
    Returns:
    
    null if control is not inside this panel.
  - getControlIndex
```
public int getControlIndex(Component c)
```
    Gets the control index in the panel from a Component.
    
    Returns:
    
    -1 if control is not inside this panel.
  - issueActionEvent
```
public boolean issueActionEvent(AEvent ae)
```
    Issue action event to server.
  - issueUpdate
```
public void issueUpdate(AEvent ae,
                        Transaction trans)
```
    Issue update for all controls (NoteBook will result in recursive call).
  - addKeyPressedListener
```
public void addKeyPressedListener(KeyPressedListener listener)
```
    Adds a listener for pressed keys. This is typical for controls processing mnemonics, etc.
  - removeKeyPressedListener
```
public void removeKeyPressedListener(KeyPressedListener listener)
```
    Removes a listener for pressed keys.
    
    See Also:
    
    addKeyPressedListener(se.entra.phantom.client.KeyPressedListener)
  - getAverageCharWidth
```
public int getAverageCharWidth()
```
    Gets the average font width for the panel in the panel font.
  - getFontHeight
```
public int getFontHeight()
```
    Get font height.
  - onCloseWindow
```
public void onCloseWindow()
```
    Closes the frame or the internal frame. This will send a close transaction to the server and wait for a response.
    
    Specified by:
    
    onCloseWindow in interface CloseWindow
  - run
```
public void run()
```
    Method to send changes of current selection to the server.
    
    Specified by:
    
    run in interface Runnable
  - getWidth
```
public int getWidth()
```
    The width of this panel.
  - getHeight
```
public int getHeight()
```
    The height of this panel.
  - vetoableChange
```
public void vetoableChange(PropertyChangeEvent e)
                    throws PropertyVetoException
```
    Checks for maximize property being set on pop-up panels that can't be maximized.
    
    Specified by:
    
    vetoableChange in interface VetoableChangeListener
    
    Throws:
    
    PropertyVetoException
  - setDocked
```
public void setDocked()
```
    Flags panel as docked.
  - copyPanel
```
public void copyPanel(boolean asImage)
```
    Copies the entire panel to the clipboard, optionally as an image. If this call is directed to a notebook page panel, it is redirected to the frame of the notebook.

Class PPanel

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isMainPanel

isApplicationPanel

panelFrame

Method Detail

hasIDs

getPanelID

getSessionManager

getPhantomApplet

getSession

getPanelIndex

isApplicationPanel

isDisposeInProgress

isCreateInProgress

resetDefaultFocus

getMostRecentFocusOwner

requestDefaultFocus

isEnabled

setEnabled

isPanelLocked

setPanelLock

getPanelFromComponent

isChild

isNoteBookPage

getMenu

isMainPanel

getFrame

getIcons

getContainer

getBarContainer

getControlCount

getControl

getControl

getControl

getControlIndex

issueActionEvent

issueUpdate

addKeyPressedListener

removeKeyPressedListener

getAverageCharWidth

getFontHeight

onCloseWindow

run

getWidth

getHeight

vetoableChange

setDocked

copyPanel