au.edu.swin.synergy.plugin.mod13.event
Class BAddPanelCE

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--au.edu.swin.synergy.kernel.BCommandEvent
              |
              +--au.edu.swin.synergy.plugin.mod13.event.BWindowCE
                    |
                    +--au.edu.swin.synergy.plugin.mod13.event.BAddPanelCE

public class BAddPanelCE

extends BWindowCE

This event will allow other plugins to add panels to the interface without having to use windows

Author:

Tristan Austin Please complete these missing tags

Copyright Belongs To:

See Also:

Serialized Form

Field Summary

static int	kBottom Place the panel on the bottom of the main screen
static int	kLeft Places the panel on the left hand side of the main screen
static int	kRight Places the panel on the left hand side of the main screen
static int	kTop Place the panel on the bottom of the main screen

Fields inherited from class au.edu.swin.synergy.kernel.BCommandEvent

connectionID, index, kBroadcast, kClient, kClientDone, kLocal, kServer, kServerDone, networkStatus, serialVersionUID

Fields inherited from class java.util.EventObject

source

Constructor Summary

BAddPanelCE(Object source, JComponent newPanel, Object newName, int newLocation)
Creates a new add panel event with the given source and the location to place it in the window manager.

BAddPanelCE(Object source, JComponent newPanel, Object newName, int newLocation, boolean useScrollPane)
Creates a new add panel event with the given source and the location to place it in the window manager

Method Summary

int	getLocation() Gets the location to place this new panel
Object	getName() This will return the name of the panel for display purposes.
JComponent	getPanel() Gets the panel to add
boolean	getScrollBarPolicy() Indicates whether they wish the component to be placed on a scroll pane or not.
int	getStepSize() When the dynamic pane is resizing, you can specify the incrementing values so that it snaps to certain sizes when the user releases the mouse.
void	setStepSize(int stepSize) When the dynamic pane is resizing, you can specify the incrementing values so that it snaps to certain sizes when the user releases the mouse.

Methods inherited from class au.edu.swin.synergy.kernel.BCommandEvent

decrementThreadCount, doComplete, doInit, getAutoComplete, getCompletionObject, getCompletionStatus, getConnectionID, getIndex, getNetworkStatus, getPipe, getUndoable, setAutoComplete, setCompletionObject, setCompletionStatus, setConnectionID, setIndex, setNetworkStatus, setPipe, setThreadCount, setUndoable

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

kLeft

public static final int kLeft

Places the panel on the left hand side of the main screen

kBottom

public static final int kBottom

Place the panel on the bottom of the main screen

kRight

public static final int kRight

Places the panel on the left hand side of the main screen

kTop

public static final int kTop

Place the panel on the bottom of the main screen

Constructor Detail

BAddPanelCE

public BAddPanelCE(Object source,
                   JComponent newPanel,
                   Object newName,
                   int newLocation)

Creates a new add panel event with the given source and the location to place it in the window manager. This defaults to using a scroll pane.

Parameters:

source - The source of the event

newPanel - The panel to add, this can be any subclass of JComponent at all

newLocation - The location to place the panel Please complete the missing tags for BAddPanelCE

BAddPanelCE

public BAddPanelCE(Object source,
                   JComponent newPanel,
                   Object newName,
                   int newLocation,
                   boolean useScrollPane)

Creates a new add panel event with the given source and the location to place it in the window manager

Parameters:

source - The source of the event

newPanel - The panel to add, this can be any subclass of JComponent at all

newLocation - The location to place the panel

useScrollPane - True to place the component on a scroll pane, false otherwise Please complete the missing tags for BAddPanelCE

Method Detail

getName

public Object getName()

This will return the name of the panel for display purposes. Please complete the missing tags for getName

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getScrollBarPolicy

public boolean getScrollBarPolicy()

Indicates whether they wish the component to be placed on a scroll pane or not.

Returns:

True if they do, false otherwise

setStepSize

public void setStepSize(int stepSize)

When the dynamic pane is resizing, you can specify the incrementing values so that it snaps to certain sizes when the user releases the mouse.

Parameters:

stepSize - The step size in pixels

getStepSize

public int getStepSize()

When the dynamic pane is resizing, you can specify the incrementing values so that it snaps to certain sizes when the user releases the mouse.

This method will get the step size currently set

Parameters:

The - step size in pixels, -1 if none

getPanel

public JComponent getPanel()

Gets the panel to add

Parameters:

-

Returns:

The panel to add Please complete the missing tags for getPanel

Pre Condition:

Post Condition:

getLocation

public int getLocation()

Gets the location to place this new panel

Parameters:

-

Returns:

Returns the location as defined in this class Please complete the missing tags for getLocation

Pre Condition:

Post Condition: