com.sibvisions.rad.ui.qt.impl.container
Class QtAbstractFrame<C extends QWidget>

java.lang.Object
  com.sibvisions.rad.ui.qt.impl.QtResource<C>
      com.sibvisions.rad.ui.qt.impl.QtComponentBase<C>
          com.sibvisions.rad.ui.qt.impl.QtComponent<C>
              com.sibvisions.rad.ui.qt.impl.QtContainer<C>
                  com.sibvisions.rad.ui.qt.impl.container.QtAbstractFrame<C>

Type Parameters:

C - a QWidget implementation, as frame

All Implemented Interfaces:

IFrame, IToolBarPanel, IWindow, IAlignmentConstants, IComponent, IContainer, IResource

Direct Known Subclasses:

QtFrame, QtInternalFrame

public abstract class QtAbstractFrame<C extends QWidget>
extends QtContainer<C>
implements IFrame

The QtFrame is the IFrame implementation for QT.
I is a top-level window with a title and a border.

The size of the frame includes any area designated for the border.

See Also:

IFrame

Field Summary

protected WindowHandler	eventWindowActivated EventHandler for windowActivated.
protected WindowHandler	eventWindowClosed EventHandler for windowClosed.
protected WindowHandler	eventWindowClosing EventHandler for windowClosing.
protected WindowHandler	eventWindowDeactivated EventHandler for windowDeactivated.
protected WindowHandler	eventWindowDeiconified EventHandler for windowDeiconified.
protected WindowHandler	eventWindowIconified EventHandler for windowIconified.
protected WindowHandler	eventWindowOpened EventHandler for windowOpened.
protected IMenuBar	menuBar contains the menu bar of the frame.

Fields inherited from class com.sibvisions.rad.ui.qt.impl.QtComponent

parent

Fields inherited from class com.sibvisions.rad.ui.qt.impl.QtComponentBase

factory

Fields inherited from class com.sibvisions.rad.ui.qt.impl.QtResource

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_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

QtAbstractFrame(C pFrame)
Creates a new instance of QtFrame based on a QWidget.

Method Summary

void	close() Close the frame and sends the closing event.
void	dispose() Releases all of the native screen resources used by this IWindow, its subcomponents, and all of its owned children.
WindowHandler	eventWindowActivated() The EventHandler for the window activated event.
WindowHandler	eventWindowClosed() The EventHandler for the window closed event.
WindowHandler	eventWindowClosing() The EventHandler for the window closing event.
WindowHandler	eventWindowDeactivated() The EventHandler for the window deactivated event.
WindowHandler	eventWindowDeiconified() The EventHandler for the window deiconified event.
WindowHandler	eventWindowIconified() The EventHandler for the window iconified event.
WindowHandler	eventWindowOpened() The EventHandler for the window opened event.
IImage	getIconImage() Returns the image to be displayed as the icon for this frame.
IMenuBar	getMenuBar() Returns the menubar set on this frame.
int	getState() Gets the state of this frame (obsolete).
String	getTitle() Gets the title of the frame.
boolean	isActive() Returns whether this IWindow is active.
boolean	isClosed() Checks if the frame was closed.
boolean	isDisposed() Checks if the frame was disposed.
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	setCursor(ICursor pCursor) Sets the cursor of the glass pane as "global" cursor.
void	setIconImage(IImage pIconImage) Sets the image to be displayed as the icon for this window.
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	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.
void	windowActivated() Sends the UIWindowEvent.WINDOW_ACTIVATED event to all listeners.
void	windowClosed() Sends the UIWindowEvent.WINDOW_CLOSED event to all listeners.
boolean	windowClosing() Sends the UIWindowEvent.WINDOW_CLOSING event to all listeners.
void	windowDeactivated() Sends the UIWindowEvent.WINDOW_DEACTIVATED event to all listeners.
void	windowDeiconified() Sends the UIWindowEvent.WINDOW_DEICONIFIED event to all listeners.
void	windowIconified() Sends the UIWindowEvent.WINDOW_ICONIFIED event to all listeners.
void	windowOpened() Sends the UIWindowEvent.WINDOW_OPENED event to all listeners.

Methods inherited from class com.sibvisions.rad.ui.qt.impl.QtContainer

add, add, add, add, addIntern, checkAdd, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, removeIntern, setLayout, setLayoutIntern

Methods inherited from class com.sibvisions.rad.ui.qt.impl.QtComponent

addStyle, capture, getBackground, getBounds, getCursor, getFont, getForeground, getHorizontalAlignment, getLocation, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyleSheet, getToolTipText, getVerticalAlignment, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, requestFocus, setBackground, setBounds, setEnabled, setFocusable, setFont, setForeground, setHorizontalAlignment, setLocation, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setResourceVisible, setSize, setToolTipText, setVerticalAlignment

Methods inherited from class com.sibvisions.rad.ui.qt.impl.QtComponentBase

eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getFactory, isVisible, setFactory, setVisible

Methods inherited from class com.sibvisions.rad.ui.qt.impl.QtResource

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

setMenuBar

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

setLocationRelativeTo

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, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getFactory, getFont, getForeground, getLocation, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setEnabled, setFocusable, setFont, setForeground, setLocation, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

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, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getFactory, getFont, getForeground, getLocation, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setEnabled, setFocusable, setFont, setForeground, setLocation, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Field Detail

menuBar

protected IMenuBar menuBar

contains the menu bar of the frame.

eventWindowOpened

protected WindowHandler eventWindowOpened

EventHandler for windowOpened.

eventWindowClosing

protected WindowHandler eventWindowClosing

EventHandler for windowClosing.

eventWindowClosed

protected WindowHandler eventWindowClosed

EventHandler for windowClosed.

eventWindowActivated

protected WindowHandler eventWindowActivated

EventHandler for windowActivated.

eventWindowDeactivated

protected WindowHandler eventWindowDeactivated

EventHandler for windowDeactivated.

eventWindowIconified

protected WindowHandler eventWindowIconified

EventHandler for windowIconified.

eventWindowDeiconified

protected WindowHandler eventWindowDeiconified

EventHandler for windowDeiconified.

Constructor Detail

QtAbstractFrame

public QtAbstractFrame(C pFrame)

Creates a new instance of QtFrame based on a QWidget.

Parameters:

pFrame - a widget implementation

Method Detail

setIconImage

public void setIconImage(IImage pIconImage)

Sets the image to be displayed as the icon for this window.

Specified by:

setIconImage in interface IFrame

Parameters:

pIconImage - 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()

getIconImage

public IImage getIconImage()

Returns the image to be displayed as the icon for this frame.

Specified by:

getIconImage in interface IFrame

Returns:

the icon image for this frame, or null if this frame doesn't have an icon image.

See Also:

IFrame.setIconImage(IImage)

getMenuBar

public IMenuBar getMenuBar()

Returns the menubar set on this frame.

Specified by:

getMenuBar in interface IFrame

Returns:

the menubar for this frame

See Also:

IFrame.setMenuBar(javax.rad.ui.menu.IMenuBar)

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()

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)

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()

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)

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)

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)

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).

Note: When the last displayable window within the Java virtual machine (VM) is disposed of, the VM may terminate. See AWT Threading Issues for more information.

Specified by:

dispose in interface IWindow

See Also:

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

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()

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.

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()

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

eventWindowOpened

public WindowHandler eventWindowOpened()

The EventHandler for the window opened event.

Specified by:

eventWindowOpened in interface IWindow

Returns:

the EventHandler for the window opened event.

eventWindowClosing

public WindowHandler eventWindowClosing()

The EventHandler for the window closing event.

Specified by:

eventWindowClosing in interface IWindow

Returns:

the EventHandler for the window closing event.

eventWindowClosed

public WindowHandler eventWindowClosed()

The EventHandler for the window closed event.

Specified by:

eventWindowClosed in interface IWindow

Returns:

the EventHandler for the window closed event.

eventWindowIconified

public WindowHandler eventWindowIconified()

The EventHandler for the window iconified event.

Specified by:

eventWindowIconified in interface IWindow

Returns:

the EventHandler for the window iconified event.

eventWindowDeiconified

public WindowHandler eventWindowDeiconified()

The EventHandler for the window deiconified event.

Specified by:

eventWindowDeiconified in interface IWindow

Returns:

the EventHandler for the window deiconified event.

eventWindowActivated

public WindowHandler eventWindowActivated()

The EventHandler for the window activated event.

Specified by:

eventWindowActivated in interface IWindow

Returns:

the EventHandler for the window activated event.

eventWindowDeactivated

public WindowHandler eventWindowDeactivated()

The EventHandler for the window deactivated event.

Specified by:

eventWindowDeactivated in interface IWindow

Returns:

the EventHandler for the window deactivated event.

setCursor

public void setCursor(ICursor pCursor)

Sets the cursor of the glass pane as "global" cursor.

Specified by:

setCursor in interface IComponent

Overrides:

setCursor in class QtComponent<C extends QWidget>

Parameters:

pCursor - the "global" cursor

See Also:

IComponent.isEnabled(), IComponent.getCursor(), Toolkit.createCustomCursor(java.awt.Image, java.awt.Point, java.lang.String), ICursor

windowOpened

public void windowOpened()

Sends the UIWindowEvent.WINDOW_OPENED event to all listeners.

windowClosing

public boolean windowClosing()

Sends the UIWindowEvent.WINDOW_CLOSING event to all listeners.

Returns:

true if the frame should be closed, otherwise false. If the closing action is not set, then true will be returned, otherwise false will be returned and the listening action has to close the frame.

windowClosed

public void windowClosed()

Sends the UIWindowEvent.WINDOW_CLOSED event to all listeners.

windowActivated

public void windowActivated()

Sends the UIWindowEvent.WINDOW_ACTIVATED event to all listeners.

windowDeactivated

public void windowDeactivated()

Sends the UIWindowEvent.WINDOW_DEACTIVATED event to all listeners.

windowIconified

public void windowIconified()

Sends the UIWindowEvent.WINDOW_ICONIFIED event to all listeners.

windowDeiconified

public void windowDeiconified()

Sends the UIWindowEvent.WINDOW_DEICONIFIED event to all listeners.

close

public void close()

Close the frame and sends the closing event.

isClosed

public boolean isClosed()

Checks if the frame was closed.

Returns:

true if the frame was closed, false otherwise

isDisposed

public boolean isDisposed()

Checks if the frame was disposed.

Specified by:

isDisposed in interface IWindow

Returns:

true if the frame was disposed, false otherwise