public class IlvMDIDockingArea extends Object implements IlvMDIClient, IlvMDIContainerTemplate
DEFAULT_WINDOW_LIST_COMMAND
Constructor and Description |
---|
IlvMDIDockingArea(IlvDockingArea dockingArea,
String emptyDockableName,
String styleReferenceDockableName)
Creates a new
IlvMDIDockingArea associated with the
specified dockingArea . |
IlvMDIDockingArea(IlvDockingArea dockingArea,
String emptyDockableName,
String styleReferenceDockableName,
boolean emptyPaneAlwaysHidden)
Creates a new
IlvMDIDockingArea associated with the
specified dockingArea . |
Modifier and Type | Method and Description |
---|---|
void |
addMDICLientListener(MDIClientListener listener)
Adds the specified MDI client listener to receive events from this
MDI client.
|
void |
addViewContainer(IlvMDIViewContainer viewContainer)
Adds a newly created tab to the tabbed pane.
|
boolean |
closeTab(String name)
Closes the dockable tab with the specified name.
|
IlvMDIViewContainer |
createViewContainer(IlvDocument document)
Creates a new MDI tab for the specified document.
|
IlvMDIViewContainer |
getActiveViewContainer()
Returns the MDI tab currently active in the MDI client.
|
IlvApplication |
getApplication()
Returns the application associated with this tabbed pane.
|
Container |
getClientContainer()
Returns the container that owns all the MDI child containers.
|
ActionListener |
getCloseActionListener()
Returns the action listener that is invoked when the close button of a
dockable pane created by this object has been pressed.
|
String |
getDockableName(IlvMDIViewContainer viewContainer)
Returns the name of the dockable pane corresponding to the specified
view container.
|
IlvDockingArea |
getDockingArea()
Returns the docking area associated with this object.
|
String |
getDocumentListActionCommand()
Gets the command name of the action list that is used for
displaying the list of opened documents in this MDI client.
|
ActionListener |
getPinActionListener()
Returns the action listener that is invoked when the pin button of a
dockable pane created by this object has been pressed.
|
boolean |
isEmptyPaneAlwaysHidden()
Determines whether the empty panel is always hidden.
|
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 associated with this tabbed pane.
|
void |
setCloseActionListener(ActionListener listener)
Sets the action listener that is invoked when the close button of a
dockable pane created by this object has been pressed.
|
void |
setDocumentListActionCommand(String command)
Sets the command name of the action list that is used for
displaying the list of opened documents in this MDI client.
|
void |
setPinActionListener(ActionListener listener)
Sets the action listener that is invoked when the pin button of a
dockable pane created by this object has been pressed.
|
void |
setTitleFrame(JFrame frame)
Sets the frame whose title will be completed with the title of the
active tab of the docking area.
|
public IlvMDIDockingArea(IlvDockingArea dockingArea, String emptyDockableName, String styleReferenceDockableName)
IlvMDIDockingArea
associated with the
specified dockingArea
.dockingArea
- The docking area to create new dockable tabs into.emptyDockableName
- The name of the dockable to add new dockable
tabs into. It is the responsibility of the JAppFrame user to register
a component associated with this dockable name. Typically, this component
should be an empty panel.styleReferenceDockableName
- The name of the dockable which styles
are used to initialize the new created tabs.IlvMDIDockingArea(ilog.views.appframe.swing.docking.IlvDockingArea, java.lang.String, java.lang.String, boolean)
public IlvMDIDockingArea(IlvDockingArea dockingArea, String emptyDockableName, String styleReferenceDockableName, boolean emptyPaneAlwaysHidden)
IlvMDIDockingArea
associated with the
specified dockingArea
.dockingArea
- The docking area to create new dockable tabs into.emptyDockableName
- The name of the dockable to add new dockable
tabs into. It is the responsibility of the JAppFrame user to register
a component associated with this dockable name. Typically, this component
should be an empty panel.styleReferenceDockableName
- The name of the dockable which styles
are used to initialize the new created tabs.emptyPaneAlwaysHidden
- Specifies whether the empty pane of this MDI docking area
should be kept always hidden.
If this parameter is false
, what corresponds to the
default mode, the empty pane is set visible
in the following cases:
true
, the empty panel will never be visible,
even in the cases listed above.public IlvMDIViewContainer getActiveViewContainer()
getActiveViewContainer
in interface IlvMDIClient
null
if the MDI
client does not contain MDI tabs.public void addMDICLientListener(MDIClientListener listener)
null
, no exception is thrown and no
action is performed.addMDICLientListener
in interface IlvMDIClient
listener
- The MDI client listener to add.public void removeMDIClientListener(MDIClientListener listener)
listener
is null
, no exception is thrown
and no action is performed.removeMDIClientListener
in interface IlvMDIClient
listener
- The MDI client listener to remove.public Container getClientContainer()
getClientContainer
in interface IlvMDIClient
public void setTitleFrame(JFrame frame)
setTitleFrame
in interface IlvMDIClient
frame
- The frame whose title is completed with the title of the
active tab.public IlvApplication getApplication()
getApplication
in interface IlvMDIClient
setApplication(ilog.views.appframe.IlvApplication)
public void setApplication(IlvApplication application)
setApplication
in interface IlvMDIClient
application
- The application of the tabbed pane.getApplication()
public String getDocumentListActionCommand()
getDocumentListActionCommand
in interface IlvMDIClient
public void setDocumentListActionCommand(String command)
command
- The command name of the action list.public IlvMDIViewContainer createViewContainer(IlvDocument document)
createViewContainer
in interface IlvMDIContainerTemplate
IlvMDITab
class.IlvMDIContainerTemplate.addViewContainer(ilog.views.appframe.docview.IlvMDIViewContainer)
public void addViewContainer(IlvMDIViewContainer viewContainer)
addViewContainer
in interface IlvMDIContainerTemplate
viewContainer
- The newly created tab to add.IlvMDITab
public String getDockableName(IlvMDIViewContainer viewContainer)
viewContainer
- The view container to retrieve the dockable
pane name of.null
if the view container was
not created using this MDI docking area.public boolean closeTab(String name)
public IlvDockingArea getDockingArea()
public void setPinActionListener(ActionListener listener)
listener
- The action listener.getPinActionListener()
public ActionListener getPinActionListener()
public void setCloseActionListener(ActionListener listener)
listener
- The action listener.getCloseActionListener()
public ActionListener getCloseActionListener()
public final boolean isEmptyPaneAlwaysHidden()
false
unless the constructor
IlvMDIDockingArea(ilog.views.appframe.swing.docking.IlvDockingArea, java.lang.String, java.lang.String, boolean)
has been called with true
as the emptyPanelAlwaysHidden
parameter.true
if the MDI panel should always be hidden.
Otherwise, this method returns false
.IlvMDIDockingArea(ilog.views.appframe.swing.docking.IlvDockingArea, java.lang.String, java.lang.String, boolean)
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.