com.sibvisions.rad.ui.swing.impl.container
Class SwingInternalFrame

java.lang.Object
  extended by com.sibvisions.rad.ui.awt.impl.AwtResource<C>
      extended by com.sibvisions.rad.ui.awt.impl.AwtComponent<C>
          extended by com.sibvisions.rad.ui.awt.impl.AwtContainer<C>
              extended by com.sibvisions.rad.ui.swing.impl.container.SwingAbstractFrame<JVxInternalFrame>
                  extended by com.sibvisions.rad.ui.swing.impl.container.SwingInternalFrame
All Implemented Interfaces:
ComponentListener, FocusListener, KeyListener, MouseListener, EventListener, IFrame, IInternalFrame, IToolBarPanel, IWindow, IAlignmentConstants, IComponent, IContainer, IResource, INamedObject, InternalFrameListener

public class SwingInternalFrame
extends SwingAbstractFrame<JVxInternalFrame>
implements IInternalFrame, InternalFrameListener

The SwingInternalFrame is the IInternalFrame implementation for swing.

See Also:
JInternalFrame, IInternalFrame

Field Summary
 
Fields inherited from class com.sibvisions.rad.ui.swing.impl.container.SwingAbstractFrame
bDisposed, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, iconImage, menuBar
 
Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtComponent
bComponentListener, bFocusListener, bKeyListener, bMouseListener, eventComponentMoved, eventComponentResized, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, eventSource, factory, parent
 
Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource
resource
 
Fields inherited from interface javax.rad.ui.container.IFrame
ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, NORMAL
 
Fields inherited from interface javax.rad.ui.container.IToolBarPanel
AREA_BOTTOM, AREA_LEFT, AREA_RIGHT, AREA_TOP
 
Fields inherited from interface javax.rad.ui.IAlignmentConstants
ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP
 
Constructor Summary
SwingInternalFrame(IDesktopPanel pDesktopPanel)
          Creates a new instance of SwingInternalFrame.
 
Method Summary
 void centerRelativeTo(IComponent pComponent)
          Centers the window relative to the specified component.
 void close()
          Closes this internal frame.
 void dispose()
          Marks the frame as disposed.
 int getState()
          Gets the state of this frame (obsolete).
 String getTitle()
          Gets the title of the frame.
 TranslationMap getTranslation()
          Gets the translation for the window.
 void internalFrameActivated(InternalFrameEvent pEvent)
          
 void internalFrameClosed(InternalFrameEvent pEvent)
          Removes the internal frame from it's parent.
 void internalFrameClosing(InternalFrameEvent pEvent)
          
 void internalFrameDeactivated(InternalFrameEvent pEvent)
          
 void internalFrameDeiconified(InternalFrameEvent pEvent)
          
 void internalFrameIconified(InternalFrameEvent pEvent)
          
 void internalFrameOpened(InternalFrameEvent pEvent)
          
 boolean isActive()
          Returns whether this IWindow is active.
 boolean isClosable()
          Returns whether this internal frame can be closed by some user action.
 boolean isClosed()
          Returns whether this IInternalFrame is currently closed.
 boolean isIconifiable()
          Returns whether this internal frame can be iconified by some user action.
 boolean isMaximizable()
          Returns whether this internal frame can be maximized by some user action.
 boolean isModal()
          Returns the modal option of the internal frame.
 boolean isResizable()
          Indicates whether this frame is resizable by the user.
 void pack()
          Causes this IWindow to be sized to fit the preferred size and layouts of its subcomponents.
 void setClosable(boolean pClosable)
          Sets whether this internal frame can be closed by some user action.
 void setIconifiable(boolean pIconifiable)
          Sets whether this internal frame can be iconified by some user action.
 void setIconImage(IImage pImage)
          Sets the image to be displayed as the icon for this window.
 void setMaximizable(boolean pMaximizable)
          Sets whether this internal frame can be maximized by some user action.
 void setMenuBar(IMenuBar pMenuBar)
          Sets the menubar for this frame.
 void setModal(boolean pModal)
          Sets the frame as modal frame.
 void setResizable(boolean pResizable)
          Sets whether this frame is resizable by the user.
 void setState(int pState)
          Sets the state of this frame (obsolete).
 void setTitle(String pTitle)
          Sets the title for this frame to the specified string.
 void setTranslation(TranslationMap pTranslation)
          Sets the translation for the window.
 void toBack()
          If this IWindow is visible, sends this IWindow to the back and may cause it to lose focus or activation if it is the focused or active Window.
 void toFront()
          If this IWindow is visible, brings this IWindow to the front and may make it the focused Window.
 
Methods inherited from class com.sibvisions.rad.ui.swing.impl.container.SwingAbstractFrame
addIntern, addToolBar, addToolBar, addToolBarIntern, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, getIconImage, getMenuBar, getToolBar, getToolBarArea, getToolBarCount, indexOfToolBar, isDisposed, removeAllToolBars, removeIntern, removeToolBar, removeToolBar, removeToolBarIntern, setCursor, setLayoutIntern, setToolBarArea, setVisible
 
Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtContainer
add, add, add, add, checkAdd, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, setLayout
 
Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtComponent
addComponentListener, addFocusListener, addKeyListener, addMouseListener, capture, componentHidden, componentMoved, componentResized, componentShown, createImage, createMouseEvent, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, focusGained, focusLost, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getHorizontalAlignment, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, getVerticalAlignment, invalidateLayout, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, requestFocus, setBackground, setBounds, setEnabled, setEventSource, setFactory, setFocusable, setFont, setForeground, setHorizontalAlignment, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVerticalAlignment, validate
 
Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource
equals, getResource, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.rad.ui.container.IFrame
getIconImage, getMenuBar
 
Methods inherited from interface javax.rad.ui.container.IWindow
eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, isDisposed
 
Methods inherited from interface javax.rad.ui.container.IToolBarPanel
addToolBar, addToolBar, getToolBar, getToolBarArea, getToolBarCount, indexOfToolBar, removeAllToolBars, removeToolBar, removeToolBar, setToolBarArea
 
Methods inherited from interface javax.rad.ui.IContainer
add, add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, setLayout
 
Methods inherited from interface javax.rad.ui.IComponent
capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible
 
Methods inherited from interface javax.rad.ui.IResource
getResource
 

Constructor Detail

SwingInternalFrame

public SwingInternalFrame(IDesktopPanel pDesktopPanel)
Creates a new instance of SwingInternalFrame.

Parameters:
pDesktopPanel - the DesktopPanel
Method Detail

getTitle

public String getTitle()
Gets the title of the frame. The title is displayed in the frame's border.

Specified by:
getTitle in interface IFrame
Returns:
the title of this frame, or an empty string ("") if this frame doesn't have a title.
See Also:
IFrame.setTitle(String)

setTitle

public void setTitle(String pTitle)
Sets the title for this frame to the specified string.

Specified by:
setTitle in interface IFrame
Parameters:
pTitle - the title to be displayed in the frame's border. A null value is treated as an empty string, "".
See Also:
IFrame.getTitle()

setIconImage

public void setIconImage(IImage pImage)
Sets the image to be displayed as the icon for this window.

Specified by:
setIconImage in interface IFrame
Parameters:
pImage - the icon image to be displayed. If this parameter is null then the icon image is set to the default image, which may vary with platform.
See Also:
IFrame.getIconImage()

getState

public int getState()
Gets the state of this frame (obsolete).

In older versions of JDK a frame state could only be NORMAL or ICONIFIED. Since JDK 1.4 set of supported frame states is expanded and frame state is represented as a bitwise mask.

For compatibility with old programs this method still returns Frame.NORMAL and Frame.ICONIFIED but it only reports the iconic state of the frame, other aspects of frame state are not reported by this method.

Specified by:
getState in interface IFrame
Returns:
Frame.NORMAL or Frame.ICONIFIED.
See Also:
IFrame.setState(int)

setState

public void setState(int pState)
Sets the state of this frame (obsolete).

In older versions of JDK a frame state could only be NORMAL or ICONIFIED. Since JDK 1.4 set of supported frame states is expanded and frame state is represented as a bitwise mask.

For compatibility with old programs this method still accepts Frame.NORMAL and Frame.ICONIFIED but it only changes the iconic state of the frame, other aspects of frame state are not affected by this method.

Specified by:
setState in interface IFrame
Parameters:
pState - either Frame.NORMAL or Frame.ICONIFIED.
See Also:
IFrame.getState(), IFrame.setState(int)

setClosable

public void setClosable(boolean pClosable)
Sets whether this internal frame can be closed by some user action.

Specified by:
setClosable in interface IInternalFrame
Parameters:
pClosable - a boolean value, where true means this internal frame can be closed

isClosable

public boolean isClosable()
Returns whether this internal frame can be closed by some user action.

Specified by:
isClosable in interface IInternalFrame
Returns:
true if this internal frame can be closed

setIconifiable

public void setIconifiable(boolean pIconifiable)
Sets whether this internal frame can be iconified by some user action.

Specified by:
setIconifiable in interface IInternalFrame
Parameters:
pIconifiable - a boolean value, where true means this internal frame can be iconified

isIconifiable

public boolean isIconifiable()
Returns whether this internal frame can be iconified by some user action.

Specified by:
isIconifiable in interface IInternalFrame
Returns:
true if this internal frame can be iconified

setMaximizable

public void setMaximizable(boolean pMaximizable)
Sets whether this internal frame can be maximized by some user action.

Specified by:
setMaximizable in interface IInternalFrame
Parameters:
pMaximizable - a boolean value, where true means this internal frame can be maximized

isMaximizable

public boolean isMaximizable()
Returns whether this internal frame can be maximized by some user action.

Specified by:
isMaximizable in interface IInternalFrame
Returns:
true if this internal frame can be maximized

isResizable

public boolean isResizable()
Indicates whether this frame is resizable by the user. By default, all frames are initially resizable.

Specified by:
isResizable in interface IFrame
Returns:
true if the user can resize this frame; false otherwise.
See Also:
IFrame.setResizable(boolean)

setResizable

public void setResizable(boolean pResizable)
Sets whether this frame is resizable by the user.

Specified by:
setResizable in interface IFrame
Parameters:
pResizable - true if this frame is resizable; false otherwise.
See Also:
IFrame.isResizable()

pack

public void pack()
Causes this IWindow to be sized to fit the preferred size and layouts of its subcomponents. If the window and/or its owner are not yet displayable, both are made displayable before calculating the preferred size. The IWindow will be validated after the preferredSize is calculated.

Specified by:
pack in interface IWindow

dispose

public void dispose()
Marks the frame as disposed.

Specified by:
dispose in interface IWindow
Overrides:
dispose in class SwingAbstractFrame<JVxInternalFrame>
See Also:
IWindow.pack(), IComponent.setVisible(boolean)

close

public void close()
Closes this internal frame. If the internal frame is already closed, this method does nothing and returns immediately. Otherwise, this method begins by firing an windowClosing event. This method finishes by making the internal frame invisible and unselected, and then firing an windowClosed event.

Specified by:
close in interface IInternalFrame
See Also:
IInternalFrame.isClosed(), IWindow.dispose()

isClosed

public boolean isClosed()
Returns whether this IInternalFrame is currently closed.

Specified by:
isClosed in interface IInternalFrame
Returns:
true if this internal frame is closed, false otherwise

isActive

public boolean isActive()
Returns whether this IWindow is active. Only a Frame or a Dialog may be active. The native windowing system may denote the active Window or its children with special decorations, such as a highlighted title bar. The active Window is always either the focused Window, or the first Frame or Dialog that is an owner of the focused Window.

Specified by:
isActive in interface IWindow
Returns:
whether this is the active Window.

toFront

public void toFront()
If this IWindow is visible, brings this IWindow to the front and may make it the focused Window.

Places this IWindow at the top of the stacking order and shows it in front of any other Windows in this VM. No action will take place if this Window is not visible. Some platforms do not allow Windows which own other Windows to appear on top of those owned Windows. Some platforms may not permit this VM to place its Windows above windows of native applications, or Windows of other VMs. This permission may depend on whether a Window in this VM is already focused. Every attempt will be made to move this Window as high as possible in the stacking order; however, developers should not assume that this method will move this Window above all other windows in every situation.

Because of variations in native windowing systems, no guarantees about changes to the focused and active Windows can be made. Developers must never assume that this Window is the focused or active Window until this Window receives a WINDOW_GAINED_FOCUS or WINDOW_ACTIVATED event. On platforms where the top-most window is the focused window, this method will probably focus this Window, if it is not already focused. On platforms where the stacking order does not typically affect the focused window, this method will probably leave the focused and active Windows unchanged.

If this method causes this Window to be focused, and this Window is a Frame or a Dialog, it will also become activated. If this Window is focused, but it is not a Frame or a Dialog, then the first Frame or Dialog that is an owner of this Window will be activated.

If this window is blocked by modal dialog, then the blocking dialog is brought to the front and remains above the blocked window.

Specified by:
toFront in interface IWindow
See Also:
IWindow.toBack()

toBack

public void toBack()
If this IWindow is visible, sends this IWindow to the back and may cause it to lose focus or activation if it is the focused or active Window.

Places this IWindow at the bottom of the stacking order and shows it behind any other Windows in this VM. No action will take place is this Window is not visible. Some platforms do not allow Windows which are owned by other Windows to appear below their owners. Every attempt will be made to move this Window as low as possible in the stacking order; however, developers should not assume that this method will move this Window below all other windows in every situation.

Because of variations in native windowing systems, no guarantees about changes to the focused and active Windows can be made. Developers must never assume that this Window is no longer the focused or active Window until this Window receives a WINDOW_LOST_FOCUS or WINDOW_DEACTIVATED event. On platforms where the top-most window is the focused window, this method will probably cause this Window to lose focus. In that case, the next highest, focusable Window in this VM will receive focus. On platforms where the stacking order does not typically affect the focused window, this method will probably leave the focused and active Windows unchanged.

Specified by:
toBack in interface IWindow
See Also:
IWindow.toFront()

setMenuBar

public void setMenuBar(IMenuBar pMenuBar)
Sets the menubar for this frame.

Specified by:
setMenuBar in interface IFrame
Parameters:
pMenuBar - the menubar being placed in the frame
See Also:
IFrame.getMenuBar()

centerRelativeTo

public void centerRelativeTo(IComponent pComponent)
Centers the window relative to the specified component. If the component is not currently showing, or pComponent is null, the window is centered on the screen.

Specified by:
centerRelativeTo in interface IWindow
Parameters:
pComponent - the component in relation to which the window's location is determined

setModal

public void setModal(boolean pModal)
Sets the frame as modal frame. When a modal frame is visible it's not possible to use the underlaying components.

Specified by:
setModal in interface IInternalFrame
Parameters:
pModal - true to set this internal frame modal, otherwise false

isModal

public boolean isModal()
Returns the modal option of the internal frame.

Specified by:
isModal in interface IInternalFrame
Returns:
true if the frame is modal otherwise false

internalFrameOpened

public void internalFrameOpened(InternalFrameEvent pEvent)

Specified by:
internalFrameOpened in interface InternalFrameListener

internalFrameClosing

public void internalFrameClosing(InternalFrameEvent pEvent)

Specified by:
internalFrameClosing in interface InternalFrameListener

internalFrameClosed

public void internalFrameClosed(InternalFrameEvent pEvent)
Removes the internal frame from it's parent.

Specified by:
internalFrameClosed in interface InternalFrameListener
Parameters:
pEvent - the triggering event

internalFrameActivated

public void internalFrameActivated(InternalFrameEvent pEvent)

Specified by:
internalFrameActivated in interface InternalFrameListener

internalFrameDeactivated

public void internalFrameDeactivated(InternalFrameEvent pEvent)

Specified by:
internalFrameDeactivated in interface InternalFrameListener

internalFrameIconified

public void internalFrameIconified(InternalFrameEvent pEvent)

Specified by:
internalFrameIconified in interface InternalFrameListener

internalFrameDeiconified

public void internalFrameDeiconified(InternalFrameEvent pEvent)

Specified by:
internalFrameDeiconified in interface InternalFrameListener

setTranslation

public void setTranslation(TranslationMap pTranslation)
Sets the translation for the window. A window might have components which needs to be translated, e.g. Buttons or Menu in titlebar.

Specified by:
setTranslation in interface IWindow
Overrides:
setTranslation in class SwingAbstractFrame<JVxInternalFrame>
Parameters:
pTranslation - the translation mapping

getTranslation

public TranslationMap getTranslation()
Gets the translation for the window.

Specified by:
getTranslation in interface IWindow
Overrides:
getTranslation in class SwingAbstractFrame<JVxInternalFrame>
Returns:
the translation mapping


Copyright © 2009 SIB Visions GmbH. All Rights Reserved.