borland Packages  Class Hierarchy  jbcl.control Package  Index 

DecoratedFrame component

java.lang.Object
   +----java.awt.Component
           +----java.awt.Container
                   +----java.awt.Window
                           +----java.awt.Frame
                                   +----borland.jbcl.control.DecoratedFrame

About the DecoratedFrame component

Variables  Constructors  Properties  Methods  Event Listeners

Implements ImageObserver, MenuContainer, Serializable

The DecoratedFrame component creates a top-level window with a title. It uses BorderLayout. The center of the frame is the client and the borders are decorations.


DecoratedFrame variables

Variables implemented in this class

Variables implemented in java.awt.Component

Variables implemented in java.awt.Frame

DecoratedFrame constructors

DecoratedFrame properties

*Read-only properties **Write-only properties

Properties implemented in this class

Properties implemented in java.awt.Component

Properties implemented in java.awt.Container

Properties implemented in java.awt.Frame

Properties implemented in java.awt.Window

Properties implemented in java.lang.Object

DecoratedFrame methods

Methods implemented in this class

Methods implemented in java.awt.Component

Methods implemented in java.awt.Container

Methods implemented in java.awt.Frame

Methods implemented in java.awt.Window

Methods implemented in java.lang.Object

DecoratedFrame event listeners


DecoratedFrame variables

client

  protected Component client
The component at the center of the decorated frame window.

disposeOnClose

  protected boolean disposeOnClose

exitOnClose

  protected boolean exitOnClose
Contains the value that determines whether the application end when the window closes.

imageName

  protected String imageName
The name of the image.

url

  protected URL url
The URL of the image.

DecoratedFrame constructors

DecoratedFrame()

  public DecoratedFrame()
Constructs a DecoratedFrame. The center is the client and the borders are decorations.


DecoratedFrame properties

client

 public Component getClient()
 public void setClient(java.awt.Component client)
The center component of the DecoratedFrame.

disposeOnClose

 public boolean isDisposeOnClose()
 public void setDisposeOnClose(boolean dispose)
The disposeOnClose property controls what this window does when it receives a WindowEvent.WINDOW_CLOSING event. Setting this property to true causes the frame to dispose when it receives a WINDOW_CLOSING event. If false, nothing happens (by default) when a WINDOW_CLOSING event occurs; users must add a WindowListener and call dispose() themselves. By default, this property is true.

exitOnClose

 public boolean isExitOnClose()
 public void setExitOnClose(boolean eoc)
Controls what this window does when it receives a WindowEvent.WINDOW_CLOSING event. If exitOnClose is true, the application can end when this DecoratedFrame closes. The default value is true.

iconImage

 public void setIconImage(java.awt.Image image)
Stores the image to display when the DecoratedFrame is minimized to an icon.

iconImageName

 public String getIconImageName()
 public void setIconImageName(java.lang.String path)
The file name of the image to display when the DecoratedFrame is minimized to an icon. The file name can include a path.

iconImageURL

 public URL getIconImageURL()
 public void setIconImageURL(java.net.URL url)
The URL of the image to display when the DecoratedFrame is minimized to an icon.

preferredSize

 public Dimension getPreferredSize()
Read-only property that returns the preferred size for the DecoratedFrame window. Unlike awt.Frame, this method adds space to account for the height of the MenuBar.


DecoratedFrame methods

processWindowEvent(java.awt.event.WindowEvent)

  protected void processWindowEvent(java.awt.event.WindowEvent e)
processWindowEvent handles a window event by first calling java.awt.Window.processWindowEvent(). Then, if the window event is WindowEvent.WINDOW_CLOSING, the window has a parent, and the exitOnClose property is true, this method closes the DecoratedFrame window.

Parameters:

e
A window event.

Overrides: java.awt.Window.processWindowEvent(WindowEvent)

setupImage(java.awt.Image, java.lang.String)

  protected void setupImage(java.awt.Image im, java.lang.String path)
Calls java.awt.image.prepareImage(im, this), sets imageName to the specified path, then calls java.awt.Frame.setIconImage(im).

Parameters:

im
The image.
path
The path and file name of the image.

DecoratedFrame event listeners

This component is a source for the following event sets. For information on the standard AWT event sets, see Standard Java events.

component

 public synchronized void addComponentListener(java.awt.event.ComponentListener )
 public synchronized void removeComponentListener(java.awt.event.ComponentListener )

container

 public synchronized void addContainerListener(java.awt.event.ContainerListener )
 public void removeContainerListener(java.awt.event.ContainerListener )

focus

 public synchronized void addFocusListener(java.awt.event.FocusListener )
 public synchronized void removeFocusListener(java.awt.event.FocusListener )

key

 public synchronized void addKeyListener(java.awt.event.KeyListener )
 public synchronized void removeKeyListener(java.awt.event.KeyListener )

mouse

 public synchronized void addMouseListener(java.awt.event.MouseListener )
 public synchronized void removeMouseListener(java.awt.event.MouseListener )

mouseMotion

 public synchronized void addMouseMotionListener(java.awt.event.MouseMotionListener )
 public synchronized void removeMouseMotionListener(java.awt.event.MouseMotionListener )

window

 public synchronized void addWindowListener(java.awt.event.WindowListener )
 public synchronized void removeWindowListener(java.awt.event.WindowListener )