javax.rad.genui.container
Class UIInternalFrame

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.UIContainer<C>
              javax.rad.genui.container.AbstractWindow<C>
                  javax.rad.genui.container.AbstractFrame<IInternalFrame>
                      javax.rad.genui.container.UIInternalFrame

All Implemented Interfaces:

ITranslatable, IFrame, IInternalFrame, IToolBarPanel, IWindow, IComponent, IContainer, IResource, INamedObject, ITranslator

Direct Known Subclasses:

About, Error, Login, Message

public class UIInternalFrame
extends AbstractFrame<IInternalFrame>
implements IInternalFrame

Platform and technology independent InternalFrame. It is designed for use with AWT, Swing, SWT, JSP, JSF,... .

Field Summary

Fields inherited from class javax.rad.genui.container.AbstractFrame

iconImage, menuBar

Fields inherited from class javax.rad.genui.UIContainer

allComponents, components

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

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

Constructor Summary

	UIInternalFrame(IDesktopPanel pDesktopPanel) Creates a new instance of UIInternalFrame.
protected	UIInternalFrame(IInternalFrame pFrame, IDesktopPanel pDesktopPanel) Creates a new instance of UIInternalFrame with the given internal frame.

Method Summary

void	close() Closes this internal frame.
void	dispose() Releases all of the native screen resources used by this IWindow, its subcomponents, and all of its owned children.
boolean	isClosable() Returns whether this internal frame can be closed by some user action.
boolean	isClosed() Returns whether this IInternalFrame is currently closed.
boolean	isGlobalActive() Gets the active flag of the internal frame ignoring modal frames.
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.
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	setMaximizable(boolean pMaximizable) Sets whether this internal frame can be maximized by some user action.
void	setModal(boolean pModal) Sets the frame as modal frame.
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.
protected void	topLevelAddNotify() Top level window or frame has to start addNotify, if not notified.

Methods inherited from class javax.rad.genui.container.AbstractFrame

addNotify, addToolBar, addToolBar, beforeAddNotify, getIconImage, getMenuBar, getState, getTitle, getToolBar, getToolBarArea, getToolBarCount, indexOfToolBar, isResizable, isToolBarMovable, removeAllToolBars, removeNotify, removeToolBar, removeToolBar, setIconImage, setMenuBar, setResizable, setState, setTitle, setToolBarArea, setToolBarMovable, updateTranslation

Methods inherited from class javax.rad.genui.container.AbstractWindow

centerRelativeTo, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, isActive, isDisposed, pack, setVisible

Methods inherited from class javax.rad.genui.UIContainer

add, add, add, add, addInternal, checkAdd, contains, getComponent, getComponentCount, getComponents, getInsets, getLayout, getUIResourceContainer, indexOf, remove, remove, removeAll, removeInternal, setLayout, setUIResourceContainer, setZOrder

Methods inherited from class javax.rad.genui.UIComponent

capture, createComponentName, createComponentNamePrefix, debug, doEventKey, doTriggerPopMenu, equals, error, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKey, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getComponentUIResource, getCurrentTranslation, getCursor, getDefaultName, getEventSource, getExistingNames, getFactory, getFont, getForeground, getLocation, getLocationOffset, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPopupMenu, getPreferredSize, getResource, getRootName, getSize, getStyle, getTabIndex, getToolTipText, getTranslation, getUIComponent, hashCode, incrementNameIfExists, info, invokeAndWait, invokeAndWait, invokeInThread, invokeInThread, invokeLater, invokeLater, isBackgroundSet, isBeforeNotified, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isNotified, isPreferredSizeSet, isTranslationChanged, isTranslationEnabled, isVisible, requestFocus, setBackground, setBounds, setBounds, setCursor, setDefaultName, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocation, setLocationRelativeTo, setMaximumSize, setMaximumSize, setMinimumSize, setMinimumSize, setName, setParent, setPopupMenu, setPreferredSize, setPreferredSize, setRootName, setSize, setSize, setStyle, setTabIndex, setToolTipText, setTranslation, setTranslationEnabled, setUIComponent, translate

Methods inherited from class javax.rad.genui.UIResource

eventResourceChanged, eventResourceChanged, fireResourceChanged, getObject, getObjectNames, getUIResource, hasResourceHandler, putObject, 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, getState, getTitle, isResizable, setIconImage, setMenuBar, setResizable, setState, setTitle

Methods inherited from interface javax.rad.ui.container.IWindow

centerRelativeTo, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, getTranslation, isActive, isDisposed, pack, setTranslation

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

UIInternalFrame

public UIInternalFrame(IDesktopPanel pDesktopPanel)

Creates a new instance of UIInternalFrame.

Parameters:

pDesktopPanel - the associated desktop for the internal frame

See Also:

IInternalFrame, IDesktopPanel

UIInternalFrame

protected UIInternalFrame(IInternalFrame pFrame,
                          IDesktopPanel pDesktopPanel)

Creates a new instance of UIInternalFrame with the given internal frame.

Parameters:

pFrame - the internal frame

pDesktopPanel - the associated desktop for the internal frame

See Also:

IInternalFrame, IDesktopPanel

Method Detail

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

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

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

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

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

Overrides:

toFront in class AbstractWindow<IInternalFrame>

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

Overrides:

toBack in class AbstractWindow<IInternalFrame>

See Also:

IWindow.toFront()

topLevelAddNotify

protected void topLevelAddNotify()

Top level window or frame has to start addNotify, if not notified.

Overrides:

topLevelAddNotify in class AbstractWindow<IInternalFrame>

dispose

public void dispose()

Releases all of the native screen resources used by this IWindow, its subcomponents, and all of its owned children. That is, the resources for these IComponents will be destroyed, any memory they consume will be returned to the OS, and they will be marked as undisplayable.

The IWindow and its subcomponents can be made displayable again by rebuilding the native resources with a subsequent call to pack or show. The states of the recreated Window and its subcomponents will be identical to the states of these objects at the point where the IWindow was disposed (not accounting for additional modifications between those actions).

Specified by:

dispose in interface IWindow

Overrides:

dispose in class AbstractWindow<IInternalFrame>

See Also:

IWindow.pack(), IComponent.setVisible(boolean)

isGlobalActive

public boolean isGlobalActive()

Gets the active flag of the internal frame ignoring modal frames.

Returns:

true, if this frame is active in the desktop, ignoring modal frames.