ilog.views.appframe.swing.mdi

Interface IlvMDIClient

All Known Implementing Classes:

IlvDesktopPane, IlvMDIDockingArea, IlvMDITabbedPane

public interface IlvMDIClient

The IlvMDIClient interface for containers that manage a variable number of IlvMDIViewContainer components.
The implementation of this interface is responsible for managing the activation and deactivation of children client frames.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_WINDOW_LIST_COMMAND Default command name for the action managing the list of opened windows.

Method Summary

Modifier and Type	Method and Description
void	addMDICLientListener(MDIClientListener listener) Adds the specified MDI client listener to receive events from this MDI client.
IlvMDIViewContainer	getActiveViewContainer() Returns the view container currently active in the MDI client.
IlvApplication	getApplication() Returns the application associated with this MDI client.
Container	getClientContainer() Returns the container that owns all the MDI child containers.
String	getDocumentListActionCommand() Gets the command name of the action list that is used for displaying the list of opened documents in the MDI client.
void	removeMDIClientListener(MDIClientListener listener) Removes the specified MDI client listener so that it no longer receives MDI client events from this MDI client.
void	setApplication(IlvApplication application) Sets the application of this MDI client.
void	setTitleFrame(JFrame frame) Sets the frame whose title will be completed with the title of the active view container.

Field Detail

DEFAULT_WINDOW_LIST_COMMAND

static final String DEFAULT_WINDOW_LIST_COMMAND

Default command name for the action managing the list of opened windows. Typically, this list appears in the submenu Window of the main menu.

See Also:

Constant Field Values

Method Detail

getActiveViewContainer

IlvMDIViewContainer getActiveViewContainer()

Returns the view container currently active in the MDI client.

Returns:

The active view container; it is null if the MDI client does not contain MDI view containers.

addMDICLientListener

void addMDICLientListener(MDIClientListener listener)

Adds the specified MDI client listener to receive events from this MDI client. If it is null, no exception is thrown and no action is performed.

Parameters:

listener - The MDI client listener to add.

removeMDIClientListener

void removeMDIClientListener(MDIClientListener listener)

Removes the specified MDI client listener so that it no longer receives MDI client events from this MDI client. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If listener is null, no exception is thrown and no action is performed.

Parameters:

listener - The MDI client listener to remove.

getClientContainer

Container getClientContainer()

Returns the container that owns all the MDI child containers.

setTitleFrame

void setTitleFrame(JFrame frame)

Sets the frame whose title will be completed with the title of the active view container.

Parameters:

frame - The frame whose title is completed with the active view container title.

getDocumentListActionCommand

String getDocumentListActionCommand()

Gets the command name of the action list that is used for displaying the list of opened documents in the MDI client.

Returns:

The command name of the action list.

getApplication

IlvApplication getApplication()

Returns the application associated with this MDI client.

Returns:

The application of this MDI client.

See Also:

setApplication(ilog.views.appframe.IlvApplication)

setApplication

void setApplication(IlvApplication application)

Sets the application of this MDI client.

Parameters:

application - The application of the MDI client.

See Also:

getApplication()