com.sibvisions.rad.ui.web.impl.container
Class AbstractWebFrame

java.lang.Object
  com.sibvisions.rad.ui.web.impl.WebResource
      com.sibvisions.rad.ui.web.impl.WebComponent
          com.sibvisions.rad.ui.web.impl.WebContainer
              com.sibvisions.rad.ui.web.impl.container.WebToolBarPanel
                  com.sibvisions.rad.ui.web.impl.container.AbstractWebWindow
                      com.sibvisions.rad.ui.web.impl.container.AbstractWebFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

WebFrame, WebInternalFrame

public abstract class AbstractWebFrame
extends AbstractWebWindow
implements IFrame

Web server implementation of IFrame.

Field Summary

protected WebMenuBar

menuBar the menu bar.

Fields inherited from class com.sibvisions.rad.ui.web.impl.container.WebToolBarPanel

toolBarPanel

Fields inherited from class com.sibvisions.rad.ui.web.impl.WebContainer

components

Fields inherited from class com.sibvisions.rad.ui.web.impl.WebComponent

componentId

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

protected

AbstractWebFrame() Creates a new instance of AbstractWebFrame.

Method Summary

protected void	addPanelIntern(WebContainer pWebContainer, Object pConstraints) Adds the tool bar panel.
WebImage	getIconImage() Returns the image to be displayed as the icon for this frame.
WebMenuBar	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.
int	getToolBarArea() Gets the area where the toolbar(s) are added.
boolean	isResizable() Indicates whether this frame is resizable by the user.
void	setIconImage(IImage pIconImage) Sets the image to be displayed as the icon for this window.
void	setMenuBar(IMenuBar pMenuBar) Sets the menubar for this 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	setToolBarArea(int pToolBarArea) Sets the display area where the toolbars will be added.

Methods inherited from class com.sibvisions.rad.ui.web.impl.container.AbstractWebWindow

eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, setLocationRelativeTo

Methods inherited from class com.sibvisions.rad.ui.web.impl.container.WebToolBarPanel

add, addToolBar, addToolBar, getToolBar, getToolBarCount, indexOfToolBar, remove, removeAllToolBars, removePanelIntern, removeToolBar, removeToolBar, setLayout

Methods inherited from class com.sibvisions.rad.ui.web.impl.WebContainer

add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, removeAll

Methods inherited from class com.sibvisions.rad.ui.web.impl.WebComponent

capture, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, finalize, getAsString, getBackground, getBounds, getChangedProperties, getComponentId, getComponentName, getConstraints, getCursor, getFactory, getFont, getForeground, getHorizontalAlignment, getLocation, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getProperty, getSize, getToolTipText, getVerticalAlignment, isBackgroundSet, isChanged, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setComponentId, setConstraints, setCursor, setEnabled, setFactory, setFocusable, setFont, setForeground, setHorizontalAlignment, setLocation, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setProperty, setProperty, setSize, setToolTipText, setVerticalAlignment, setVisible

Methods inherited from class com.sibvisions.rad.ui.web.impl.WebResource

getNullableAsString, getResource, setAsString, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

dispose, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, isActive, isDisposed, pack, setLocationRelativeTo, toBack, toFront

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, setCursor, 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, getToolBarCount, indexOfToolBar, removeAllToolBars, removeToolBar, removeToolBar

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, setCursor, 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 WebMenuBar menuBar

the menu bar.

Constructor Detail

AbstractWebFrame

protected AbstractWebFrame()

Creates a new instance of AbstractWebFrame.

See Also:

IFrame

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

getIconImage

public WebImage 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)

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

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)

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

getToolBarArea

public int getToolBarArea()

Gets the area where the toolbar(s) are added.

Specified by:

getToolBarArea in interface IToolBarPanel

Overrides:

getToolBarArea in class WebToolBarPanel

Returns:

an area constant IToolBarPanel.AREA_TOP, IToolBarPanel.AREA_LEFT, IToolBarPanel.AREA_BOTTOM, IToolBarPanel.AREA_RIGHT

setToolBarArea

public void setToolBarArea(int pToolBarArea)

Sets the display area where the toolbars will be added.

Specified by:

setToolBarArea in interface IToolBarPanel

Overrides:

setToolBarArea in class WebToolBarPanel

Parameters:

pToolBarArea - an area constant IToolBarPanel.AREA_TOP, IToolBarPanel.AREA_LEFT, IToolBarPanel.AREA_BOTTOM, IToolBarPanel.AREA_RIGHT

getMenuBar

public WebMenuBar 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)

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

addPanelIntern

protected void addPanelIntern(WebContainer pWebContainer,
                              Object pConstraints)

Adds the tool bar panel.

Overrides:

addPanelIntern in class WebToolBarPanel

Parameters:

pWebContainer - the tool bar panel.

pConstraints - the constraints.