Synergy source documentation: Class BWindowBinder

Overview

Package

Class

Tree

Deprecated

Index

Synergy Documentation

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

au.edu.swin.synergy.plugin.mod13.bwt
Class BWindowBinder

java.lang.Object
  |
  +--au.edu.swin.synergy.plugin.mod13.bwt.BWindowBinder

public class BWindowBinder
extends Object
implements WindowListener, InternalFrameListener

This provides a means of plugins to listen to window events on their own steam. The Plugins will need to have an implementation of a BWindowListener class which is bound to a BWindowBinder. The BWindowBinder is added as a listener to either a Dialog, Window or a JInternalFrame. All events received by this class will be bound to the BWindowListener as they come in.

Author:: Tristan Austin Please complete these missing tags
Copyright Belongs To:

Constructor Summary
`BWindowBinder(BWindowListener windowListener, JComponent windowContent)` Creates a new BWindowBinder with the specified window listener to bind events to.

Method Summary
`boolean`	`equals(Object target)` This will compare this window binder with another window binder or a BWindowListener.
`void`	`internalFrameActivated(InternalFrameEvent internalFrameEvent)` Invoked when the internalFrame is set to be the user's active internalFrame, which means the internalFrame (or one of its subcomponents) will receive keyboard events.
`void`	`internalFrameClosed(InternalFrameEvent internalFrameEvent)` Invoked when a internalFrame has been closed as the result of calling dispose on the internalFrame.
`void`	`internalFrameClosing(InternalFrameEvent internalFrameEvent)` Invoked when the user attempts to close the internalFrame from the window's system menu.
`void`	`internalFrameDeactivated(InternalFrameEvent internalFrameEvent)` Invoked when a internalFrame is no longer the user's active internalFrame, which means that keyboard events will no longer be delivered to the internalFrame or its subcomponents.
`void`	`internalFrameDeiconified(InternalFrameEvent internalFrameEvent)` Invoked when a internalFrame is changed from a minimized to a normal state.
`void`	`internalFrameIconified(InternalFrameEvent internalFrameEvent)` Invoked when a internalFrame is changed from a normal to a minimized state.
`void`	`internalFrameOpened(InternalFrameEvent internalFrameEvent)` Invoked the first time a window is made visible.
`void`	`windowActivated(WindowEvent windowEvent)` Invoked when the window is set to be the user's active window, which means the window (or one of its subcomponents) will receive keyboard events.
`void`	`windowClosed(WindowEvent windowEvent)` Invoked when a window has been closed as the result of calling dispose on the window.
`void`	`windowClosing(WindowEvent windowEvent)` Invoked when the user attempts to close the window from the window's system menu.
`void`	`windowDeactivated(WindowEvent windowEvent)` Invoked when a window is no longer the user's active window, which means that keyboard events will no longer be delivered to the window or its subcomponents.
`void`	`windowDeiconified(WindowEvent windowEvent)` Invoked when a window is changed from a minimized to a normal state.
`void`	`windowIconified(WindowEvent windowEvent)` Invoked when a window is changed from a normal to a minimized state.
`void`	`windowOpened(WindowEvent windowEvent)` Invoked the first time a window is made visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

BWindowBinder

public BWindowBinder(BWindowListener windowListener,
                     JComponent windowContent)

Creates a new BWindowBinder with the specified window listener to bind events to. The window listener passed in here will be the object which will ultimately receive all the window events.

Parameters:: windowListener - Please complete the missing tags for BWindowBinder

Method Detail

windowOpened

public void windowOpened(WindowEvent windowEvent)

Invoked the first time a window is made visible.

Specified by:: windowOpened in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowOpened
Returns:
Pre Condition:
Post Condition:

windowClosing

public void windowClosing(WindowEvent windowEvent)

Invoked when the user attempts to close the window from the window's system menu. If the program does not explicitly hide or dispose the window while processing this event, the window close operation will be cancelled.

Specified by:: windowClosing in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowClosing
Returns:
Pre Condition:
Post Condition:

windowClosed

public void windowClosed(WindowEvent windowEvent)

Invoked when a window has been closed as the result of calling dispose on the window.

Specified by:: windowClosed in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowClosed
Returns:
Pre Condition:
Post Condition:

windowIconified

public void windowIconified(WindowEvent windowEvent)

Invoked when a window is changed from a normal to a minimized state. For many platforms, a minimized window is displayed as the icon specified in the window's iconImage property.

Specified by:: windowIconified in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowIconified
Returns:
Pre Condition:
Post Condition:

windowDeiconified

public void windowDeiconified(WindowEvent windowEvent)

Invoked when a window is changed from a minimized to a normal state.

Specified by:: windowDeiconified in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowDeiconified
Returns:
Pre Condition:
Post Condition:

windowActivated

public void windowActivated(WindowEvent windowEvent)

Invoked when the window is set to be the user's active window, which means the window (or one of its subcomponents) will receive keyboard events.

Specified by:: windowActivated in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowActivated
Returns:
Pre Condition:
Post Condition:

windowDeactivated

public void windowDeactivated(WindowEvent windowEvent)

Invoked when a window is no longer the user's active window, which means that keyboard events will no longer be delivered to the window or its subcomponents.

Specified by:: windowDeactivated in interface WindowListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for windowDeactivated
Returns:
Pre Condition:
Post Condition:

internalFrameOpened

public void internalFrameOpened(InternalFrameEvent internalFrameEvent)

Invoked the first time a window is made visible.

Specified by:: internalFrameOpened in interface InternalFrameListener
Parameters:: windowEvent - The window event fired Please complete the missing tags for internalFrameOpened
Returns:
Pre Condition:
Post Condition:

internalFrameClosing

public void internalFrameClosing(InternalFrameEvent internalFrameEvent)

Invoked when the user attempts to close the internalFrame from the window's system menu. If the program does not explicitly hide or dispose the window while processing this event, the window close operation will be cancelled.

Specified by:: internalFrameClosing in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameClosing
Returns:
Pre Condition:
Post Condition:

internalFrameClosed

public void internalFrameClosed(InternalFrameEvent internalFrameEvent)

Invoked when a internalFrame has been closed as the result of calling dispose on the internalFrame.

Specified by:: internalFrameClosed in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameClosed
Returns:
Pre Condition:
Post Condition:

internalFrameIconified

public void internalFrameIconified(InternalFrameEvent internalFrameEvent)

Invoked when a internalFrame is changed from a normal to a minimized state. For many platforms, a minimized internalFrame is displayed as the icon specified in the internalFrame's iconImage property.

Specified by:: internalFrameIconified in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameIconified
Returns:
Pre Condition:
Post Condition:

internalFrameDeiconified

public void internalFrameDeiconified(InternalFrameEvent internalFrameEvent)

Invoked when a internalFrame is changed from a minimized to a normal state.

Specified by:: internalFrameDeiconified in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameDeiconified
Returns:
Pre Condition:
Post Condition:

internalFrameActivated

public void internalFrameActivated(InternalFrameEvent internalFrameEvent)

Invoked when the internalFrame is set to be the user's active internalFrame, which means the internalFrame (or one of its subcomponents) will receive keyboard events.

Specified by:: internalFrameActivated in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameActivated
Returns:
Pre Condition:
Post Condition:

internalFrameDeactivated

public void internalFrameDeactivated(InternalFrameEvent internalFrameEvent)

Invoked when a internalFrame is no longer the user's active internalFrame, which means that keyboard events will no longer be delivered to the internalFrame or its subcomponents.

Specified by:: internalFrameDeactivated in interface InternalFrameListener
Parameters:: internalFrameEvent - The internalFrame event fired Please complete the missing tags for internalFrameDeactivated
Returns:
Pre Condition:
Post Condition:

equals

public boolean equals(Object target)

This will compare this window binder with another window binder or a BWindowListener. Two window binders are considered equal if they both have the same window listener.

Parameters:: target - The object to compare against
Returns:: True if they are the same, false otherwise Please complete the missing tags for equals
Overrides:: equals in class Object
Pre Condition:
Post Condition: