org.jesktop.frimble
Interface Frimble

All Known Implementing Classes:
AbstractFrimble, JFrimble

public interface Frimble

Frimble is just a helper class. It provides a common access to JFrame and JInternalFrame Actually if someone want to write a container that has a least a) visible title b) menu bar c) multi panes/layers d) can be in front or behind others

Version:
1.0
Author:
Paul Hammant Paul_Hammant@yahoo.com

Method Summary
 void addFrimbleListener(FrimbleListener fl)
          Method addFrimbleListener
 void addKeyListener(java.awt.event.KeyListener l)
          Method addKeyListener
 void dispose()
          Method dispose initiates a close sequence for the frimble.
 java.awt.Rectangle getBounds()
          Method getBounds
 java.awt.Container getContentPane()
          Method getContentPane gets the content pane for the frimble.
 int getDefaultCloseOperation()
          Method getDefaultCloseOperation gets the default close operation for frimble //TODO - still needs true adaption?
 java.awt.Component getFocusOwner()
          Method getFocusOwner gets the Component that is the focus owner for the frimble.
 java.awt.Component getFrimbleContained()
          Method showOpenDialog shows an save dialog (attached to this frimble).
 java.awt.Component getGlassPane()
          Method getGlassPane gets the glass pane for the frimble.
 int getHeight()
          Method getHeight
 javax.swing.JMenuBar getJMenuBar()
          Gets the Jemnubar for the frimble.
 javax.swing.JLayeredPane getLayeredPane()
          Method getLayeredPane gets the layered pane for the frimble.
 java.awt.Point getLocation()
          Method getLocation
 java.awt.Frame getOwnerFrame()
          Method getOwnerFrame
 java.awt.Dimension getPreferredSize()
          Method getPreferredSize
 javax.swing.JRootPane getRootPane()
          Method getRootPane gets the root pane for the frimble.
 java.awt.Dimension getSize()
          Method getSize
 java.lang.String getTitle()
          Method getTitle gets the title for a frimble.
 int getWidth()
          Method getWidth
 boolean isResizable()
          Method isResizable determines of the frimble supports resize.
 boolean isVisible()
          Method isVisible
 Frimble makeFrimble(FrimbleAware frimbleAwareComponent)
          Method makeFrimble
 void pack()
          Method pack packs the frimble.
 void registerFrimbleCallback(FrimbleCallback fcb)
          Method registerFrimbleCallback
 void removeFrimbleListener(FrimbleListener fl)
          Method removeFrimbleListener
 void setBackground(java.awt.Color col)
          Method setBackground
 void setClosed(boolean b)
          Method setClosed
 void setContentPane(java.awt.Container contentPane)
          Method setContentPane places a container as the content pane.
 void setDefaultCloseOperation(int operation)
          Method setDefaultCloseOperation sets the default close operation //TODO ints the same for JFrame and JInternalFrame?
 void setFrameIcon(javax.swing.ImageIcon imageIcon)
          Method setFrameIcon
 void setGlassPane(java.awt.Component glassPane)
          Method setGlassPane sets teh glass pane.
 void setIconImage(java.awt.Image image)
          Method setIconImage
 void setJMenuBar(javax.swing.JMenuBar m)
          Method setJMenuBar allows the menu bar to be set for the frimble.
 void setLayeredPane(javax.swing.JLayeredPane layeredPane)
          Method setLayeredPane sets the layered pane.
 void setLocation(int x, int y)
          Method setLocation
 void setResizable(boolean resizable)
          Method setResizable sets the resizability of this frimble.
 void setSize(java.awt.Dimension dim)
          Method setSize
 void setTitle(java.lang.String t)
          Method setTitle sets a title from the frimble
 void setVisible(boolean yesOrNo)
          Method setVisible controls the visibility of the frimble.
 void show()
          Method show same as setVisible(true).
 int showOpenDialog(javax.swing.JFileChooser chooser)
          Method showOpenDialog shows an open dialog (attached to this frimble).
 int showSaveDialog(javax.swing.JFileChooser chooser)
          Method showSaveDialog shows an save dialog (attached to this frimble).
 void toBack()
          Method toBack moves the frimble to the back of it's peer set of frimbles.
 void toFront()
          Method toFront moves the frimble to the front of it's peer set of frimbles.
 void validate()
          Method validate
 

Method Detail

addFrimbleListener

public void addFrimbleListener(FrimbleListener fl)
Method addFrimbleListener

Parameters:
fl -

removeFrimbleListener

public void removeFrimbleListener(FrimbleListener fl)
Method removeFrimbleListener

Parameters:
fl -

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar m)
Method setJMenuBar allows the menu bar to be set for the frimble.


getJMenuBar

public javax.swing.JMenuBar getJMenuBar()
Gets the Jemnubar for the frimble.


setTitle

public void setTitle(java.lang.String t)
Method setTitle sets a title from the frimble

Parameters:
t - title

getTitle

public java.lang.String getTitle()
Method getTitle gets the title for a frimble.

Returns:
the title.

pack

public void pack()
Method pack packs the frimble.


setVisible

public void setVisible(boolean yesOrNo)
Method setVisible controls the visibility of the frimble.

Parameters:
yesOrNo - visible or invisible.

getFocusOwner

public java.awt.Component getFocusOwner()
Method getFocusOwner gets the Component that is the focus owner for the frimble.


getGlassPane

public java.awt.Component getGlassPane()
Method getGlassPane gets the glass pane for the frimble.

Returns:
the glass pane.

getContentPane

public java.awt.Container getContentPane()
Method getContentPane gets the content pane for the frimble.

Returns:
the content pane.

getLayeredPane

public javax.swing.JLayeredPane getLayeredPane()
Method getLayeredPane gets the layered pane for the frimble.

Returns:
the layered pane.

getRootPane

public javax.swing.JRootPane getRootPane()
Method getRootPane gets the root pane for the frimble.

Returns:
the root pane.

isResizable

public boolean isResizable()
Method isResizable determines of the frimble supports resize.

Returns:
true for does resize.

getDefaultCloseOperation

public int getDefaultCloseOperation()
Method getDefaultCloseOperation gets the default close operation for frimble //TODO - still needs true adaption?

Returns:
the default close operation.

dispose

public void dispose()
Method dispose initiates a close sequence for the frimble.


setContentPane

public void setContentPane(java.awt.Container contentPane)
Method setContentPane places a container as the content pane.

Parameters:
contentPane - the new content pane

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)
Method setDefaultCloseOperation sets the default close operation //TODO ints the same for JFrame and JInternalFrame?

Parameters:
operation - new default close action

setGlassPane

public void setGlassPane(java.awt.Component glassPane)
Method setGlassPane sets teh glass pane.


setLayeredPane

public void setLayeredPane(javax.swing.JLayeredPane layeredPane)
Method setLayeredPane sets the layered pane.


setResizable

public void setResizable(boolean resizable)
Method setResizable sets the resizability of this frimble.


show

public void show()
Method show same as setVisible(true).


toBack

public void toBack()
Method toBack moves the frimble to the back of it's peer set of frimbles.


toFront

public void toFront()
Method toFront moves the frimble to the front of it's peer set of frimbles.


showOpenDialog

public int showOpenDialog(javax.swing.JFileChooser chooser)
Method showOpenDialog shows an open dialog (attached to this frimble).

Parameters:
chooser - the file chooser to open.
Returns:
the action chosen - see JFileChooser.

showSaveDialog

public int showSaveDialog(javax.swing.JFileChooser chooser)
Method showSaveDialog shows an save dialog (attached to this frimble).

Parameters:
chooser - the file chooser to open.
Returns:
the action chosen - see JFileChooser.

getFrimbleContained

public java.awt.Component getFrimbleContained()
Method showOpenDialog shows an save dialog (attached to this frimble).

Returns:

getOwnerFrame

public java.awt.Frame getOwnerFrame()
Method getOwnerFrame

Returns:

getSize

public java.awt.Dimension getSize()
Method getSize

Returns:

setSize

public void setSize(java.awt.Dimension dim)
Method setSize

Parameters:
dim -

setIconImage

public void setIconImage(java.awt.Image image)
Method setIconImage

Parameters:
image -

setBackground

public void setBackground(java.awt.Color col)
Method setBackground

Parameters:
col -

setClosed

public void setClosed(boolean b)
               throws java.beans.PropertyVetoException
Method setClosed

Parameters:
b -
Throws:
java.beans.PropertyVetoException

setFrameIcon

public void setFrameIcon(javax.swing.ImageIcon imageIcon)
Method setFrameIcon

Parameters:
imageIcon -

makeFrimble

public Frimble makeFrimble(FrimbleAware frimbleAwareComponent)
Method makeFrimble


registerFrimbleCallback

public void registerFrimbleCallback(FrimbleCallback fcb)
Method registerFrimbleCallback

Parameters:
fcb -

validate

public void validate()
Method validate


getPreferredSize

public java.awt.Dimension getPreferredSize()
Method getPreferredSize

Returns:

getLocation

public java.awt.Point getLocation()
Method getLocation

Returns:

setLocation

public void setLocation(int x,
                        int y)
Method setLocation

Parameters:
x -
y -

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)
Method addKeyListener

Parameters:
l -

getWidth

public int getWidth()
Method getWidth

Returns:

getHeight

public int getHeight()
Method getHeight

Returns:

getBounds

public java.awt.Rectangle getBounds()
Method getBounds

Returns:

isVisible

public boolean isVisible()
Method isVisible

Returns:


Copyright © 2004 Jesktop Project. All Rights Reserved.