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

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.BCloseWindowCE
                          |
                          +--au.edu.swin.synergy.plugin.mod13.event.BAddWindowCE

public class BAddWindowCE

extends BCloseWindowCE

This event is passed to the Window Manager with a panel and various properties to add to a Window in the GUI.

Author:

John Newbigin

See Also:

Serialized Form

Field Summary

static int	kDisposeOnClose This will destroy the window complete when the user clicks the close button
static int	kDoNothingOnClose This will make the window do nothing when the user clicks the user, it is up to a listener to deal with it.
static int	kHideOnClose This will hide the window when the user clicks the close button

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

BAddWindowCE(Object source, JComponent windowContent, Object fName)
Please complete the missing tags for BAddWindowCE

BAddWindowCE(Object source, JComponent windowContent, Object fName, BCommandComplete complete)
Please complete the missing tags for BAddWindowCE

Method Summary

void	addListenersToWindow(Container window) This will add all the window listeners specified in this add window event to the window passed in.
void	addWindowListener(BWindowListener windowListener) This will add the given window listener to the list of listeners that will receive notification of window events from the window or dialog this panel ends up on.
boolean	getClosable() Please complete the missing tags for getClosable
int	getCloseAction() Gets the default close action to that specified.
boolean	getIconifiable() Please complete the missing tags for getIconifiable
boolean	getMaximizable() Please complete the missing tags for getMaximizable
Object	getName() Please complete the missing tags for getName
JComponent	getParentDialog() Gets the parent dialog of this panel as identified by the panel given to the window manager earlier.
boolean	getResizable() Please complete the missing tags for getResizable
boolean	isDialog() Indicates whether the window is should be displayed as a dialog or not.
boolean	isModal() Indicates whether the window is should be displayed as a modal dialog or not.
void	removeWindowListener(BWindowListener windowListener) This will remove the given window listener from the list of listeners.
void	setClosable(boolean fClosable) Please complete the missing tags for setClosable
void	setCloseAction(int closeAction) Sets the default close action to that specified.
void	setDialog(boolean isDialog) Indicates that the panel should be added to a dialog and be modal.
void	setIconifiable(boolean fIconifiable) Please complete the missing tags for setIconifiable
void	setMaximizable(boolean fMaximizable) Please complete the missing tags for setMaximizable
void	setModal(boolean isModal) Indicates that the panel should be model or not.
void	setParentDialog(JComponent parentDialogContent) Specifies the parent dialog of this dialog.
void	setResizable(boolean fResizable) Please complete the missing tags for setResizable

Methods inherited from class au.edu.swin.synergy.plugin.mod13.event.BCloseWindowCE

getWindowContent

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

kHideOnClose

public static int kHideOnClose

This will hide the window when the user clicks the close button

kDoNothingOnClose

public static int kDoNothingOnClose

This will make the window do nothing when the user clicks the user, it is up to a listener to deal with it.

kDisposeOnClose

public static int kDisposeOnClose

This will destroy the window complete when the user clicks the close button

Constructor Detail

BAddWindowCE

public BAddWindowCE(Object source,
                    JComponent windowContent,
                    Object fName)

Please complete the missing tags for BAddWindowCE

Parameters:

source - The source of the event

windowContent - The component to place on the window

fName - The name of the window

Throws:

-

BAddWindowCE

public BAddWindowCE(Object source,
                    JComponent windowContent,
                    Object fName,
                    BCommandComplete complete)

Please complete the missing tags for BAddWindowCE

Parameters:

source - The source of the event

windowContent - The component to place on the window

fName - The name of the window

complete - The completion object to be notified when the window is processed

Throws:

-

Method Detail

setCloseAction

public void setCloseAction(int closeAction)

Sets the default close action to that specified. When this is set to do nothing on close, closing the window is up to a BWindow listener to send a BCloseWindowCE to the window manager.

Parameters:

closeAction - kDisposeOnClose, kDoNothingOnClose, kHideOnClose

getCloseAction

public int getCloseAction()

Gets the default close action to that specified. When this is set to do nothing on close, closing the window is up to a BWindow listener to send a BCloseWindowCE to the window manager.

Returns:

kDisposeOnClose, kDoNothingOnClose, kHideOnClose

getResizable

public boolean getResizable()

Please complete the missing tags for getResizable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

setResizable

public void setResizable(boolean fResizable)

Please complete the missing tags for setResizable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getClosable

public boolean getClosable()

Please complete the missing tags for getClosable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

setClosable

public void setClosable(boolean fClosable)

Please complete the missing tags for setClosable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getMaximizable

public boolean getMaximizable()

Please complete the missing tags for getMaximizable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

setMaximizable

public void setMaximizable(boolean fMaximizable)

Please complete the missing tags for setMaximizable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getIconifiable

public boolean getIconifiable()

Please complete the missing tags for getIconifiable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

setIconifiable

public void setIconifiable(boolean fIconifiable)

Please complete the missing tags for setIconifiable

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getName

public Object getName()

Please complete the missing tags for getName

Parameters:

-

Returns:

Throws:

-

Pre Condition:

Post Condition:

getParentDialog

public JComponent getParentDialog()

Gets the parent dialog of this panel as identified by the panel given to the window manager earlier.

Parameters:

-

Returns:

The component that is on the parent dialog Please complete the missing tags for getParentDialog

Pre Condition:

Post Condition:

setDialog

public void setDialog(boolean isDialog)

Indicates that the panel should be added to a dialog and be modal.

Parameters:

isDialog - Please complete the missing tags for setDialog

Returns:

Pre Condition:

Post Condition:

setModal

public void setModal(boolean isModal)

Indicates that the panel should be model or not. If this is not called, it will default to true. This is only used when the setDialog method is called and set to true.

Parameters:

isModal -

Pre Condition:

Post Condition:

setParentDialog

public void setParentDialog(JComponent parentDialogContent)

Specifies the parent dialog of this dialog. By placing this here, the window manager is able to make the dialog the component passed in is on, the parent of the new dialog

Parameters:

parentDialogContent - The parent of this new dialog Please complete the missing tags for setParentDialog

Returns:

Pre Condition:

Post Condition:

isModal

public boolean isModal()

Indicates whether the window is should be displayed as a modal dialog or not.

Returns:

True if it should, false otherwise

isDialog

public boolean isDialog()

Indicates whether the window is should be displayed as a dialog or not.

Parameters:

-

Returns:

True if it should, false otherwise Please complete the missing tags for isDialog

Pre Condition:

Post Condition:

addWindowListener

public void addWindowListener(BWindowListener windowListener)

This will add the given window listener to the list of listeners that will receive notification of window events from the window or dialog this panel ends up on.

Parameters:

windowListener - The window listener to add Please complete the missing tags for addWindowListener

Returns:

Pre Condition:

Post Condition:

removeWindowListener

public void removeWindowListener(BWindowListener windowListener)

This will remove the given window listener from the list of listeners.

Parameters:

windowListener - The window listener to remove Please complete the missing tags for removeWindowListener

Returns:

Pre Condition:

Post Condition:

addListenersToWindow

public void addListenersToWindow(Container window)

This will add all the window listeners specified in this add window event to the window passed in.

Parameters:

window - The window to add the listeners to Please complete the missing tags for addListenersToWindow

Returns:

Pre Condition:

Post Condition: