ICY Version 1.0.1.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Package Functions | Package Attributes | Static Package Attributes

icy.gui.frame.IcyFrame Class Reference

Inheritance diagram for icy.gui.frame.IcyFrame:
icy.gui.frame.AboutFrame icy.gui.frame.GenericFrame icy.gui.frame.LabelFrame icy.gui.frame.progress.TaskFrame icy.gui.frame.TitledFrame icy.gui.plugin.PluginDetailPanel icy.gui.preferences.PreferenceFrame icy.gui.viewer.Viewer icy.plugin.PluginUpdater icy.script.ScriptEditor

List of all members.

Classes

class  IcyExternalFrame
class  IcyInternalFrame

Public Types

enum  IcyFrameState { INTERNALIZED, EXTERNALIZED }

Public Member Functions

 IcyFrame (String title)
 IcyFrame (String title, boolean resizable)
 IcyFrame (String title, boolean resizable, boolean closable)
 IcyFrame (String title, boolean resizable, boolean closable, boolean maximizable)
 IcyFrame (final String title, final boolean resizable, final boolean closable, final boolean maximizable, final boolean iconifiable)
 IcyFrame (final String title, final boolean resizable, final boolean closable, final boolean maximizable, final boolean iconifiable, final boolean waitCreate)
Container getFrame ()
JInternalFrame getInternalFrame ()
JFrame getExternalFrame ()
JMenu getPopupMenu ()
JMenuItem getDetachMenuItem ()
void close ()
void switchState ()
void internalize ()
void externalize ()
void attach ()
void detach ()
void center ()
void addTo (final Container c)
void addTo (final Container c, final int index)
void addTo (final Container c, final Object constraints)
void addToMainDesktopPane ()
void add (final Component comp)
void add (final Component comp, final Object constraints)
void add (final String name, final Component comp)
void removeFrom (final Container c)
void removeAll ()
void remove (final Component comp)
void removeFromMainDesktopPane ()
void toFront ()
void toBack ()
void pack ()
Container getParent ()
Container getContentPane ()
JRootPane getRootPane ()
Dimension getMinimumSize ()
Dimension getMaximumSize ()
Dimension getPreferredSize ()
int getHeight ()
int getWidth ()
int getX ()
int getY ()
Point getLocation ()
Toolkit getToolkit ()
String getTitle ()
boolean getTitleBarVisible ()
Point getMousePosition ()
boolean isVisible ()
boolean isInternalized ()
boolean isExternalized ()
boolean isActive ()
void setTitle (final String title)
void setToolTipText (final String text)
void setBackground (final Color value)
void setForeground (final Color value)
void setResizable (final boolean value)
void setLocation (final Point p)
void setLocation (final int x, final int y)
void setSize (final Dimension d)
void setSize (final int width, final int height)
void setPreferredSize (final Dimension d)
void setMinimumSize (final Dimension d)
void setMaximumSize (final Dimension d)
void setLayout (final LayoutManager layout)
void setClosable (final boolean value)
void setDefaultCloseOperation (final int operation)
void setFocusable (final boolean value)
void setVisible (final boolean value)
void setJMenuBar (final JMenuBar m)
void setTitleBarVisible (final boolean value)
boolean isSyncProcess ()
void setSyncProcess (boolean syncProcess)
void requestFocus ()
void validate ()
void revalidate ()
void repaint ()
void updateUI ()
void addFrameListener (IcyFrameListener l)
void removeFrameListener (IcyFrameListener l)
void addKeyListener (KeyListener l)
void removeKeyListener (KeyListener l)
void frameClosed (AWTEvent e)
void onClosed ()
void internalFrameActivated (InternalFrameEvent e)
void internalFrameClosed (InternalFrameEvent e)
void internalFrameClosing (InternalFrameEvent e)
void internalFrameDeactivated (InternalFrameEvent e)
void internalFrameDeiconified (InternalFrameEvent e)
void internalFrameIconified (InternalFrameEvent e)
void internalFrameOpened (InternalFrameEvent e)
void windowActivated (WindowEvent e)
void windowClosed (WindowEvent e)
void windowClosing (WindowEvent e)
void windowDeactivated (WindowEvent e)
void windowDeiconified (WindowEvent e)
void windowIconified (WindowEvent e)
void windowOpened (WindowEvent e)
boolean imageUpdate (Image img, int infoflags, int x, int y, int width, int height)

Static Public Member Functions

static ArrayList< IcyFramegetAllFrames ()
static ArrayList< Image > getIcyIconImages ()
static Image getIcyIconAsImage ()
static ImageIcon getIcyImageIcon ()

Static Public Attributes

static final ImageIcon icon16 = ResourceUtil.getImageIcon("icy16.png")
static final ImageIcon icon32 = ResourceUtil.getImageIcon("icy32.png")
static final Image icyLogo = ResourceUtil.getImage("logo.png")

Package Functions

void fireFrameInternalized (IcyFrameEvent e)
void fireFrameExternalized (IcyFrameEvent e)

Package Attributes

IcyExternalFrame externalFrame
IcyInternalFrame internalFrame
JMenu popupMenu
JMenuItem detachMenuItem
IcyFrameState state
boolean syncProcess
EventListenerList frameEventListeners

Static Package Attributes

static ArrayList< IcyFrameframes = new ArrayList<IcyFrame>()

Detailed Description

This class behave either as a JFrame or a JInternalFrame.
IcyFrame is 100% thread safe (no need to be on the AWT Event dispatch thread)

Author:
Fabrice de Chaumont & Stephane Dallongeville

Member Function Documentation

void icy.gui.frame.IcyFrame.add ( final Component  comp)

Implement add method

void icy.gui.frame.IcyFrame.add ( final Component  comp,
final Object  constraints 
)

Implement add method

void icy.gui.frame.IcyFrame.add ( final String  name,
final Component  comp 
)

Implement add method

void icy.gui.frame.IcyFrame.addFrameListener ( IcyFrameListener  l)

Implement addFrameListener method

void icy.gui.frame.IcyFrame.addKeyListener ( KeyListener  l)

Implement addKeyListener method

void icy.gui.frame.IcyFrame.addTo ( final Container  c,
final Object  constraints 
)

Add to the container

void icy.gui.frame.IcyFrame.addTo ( final Container  c)

Add the a container

void icy.gui.frame.IcyFrame.addTo ( final Container  c,
final int  index 
)

Add the a container

void icy.gui.frame.IcyFrame.addToMainDesktopPane ( )

Add the frame to the main pane of ICY

void icy.gui.frame.IcyFrame.attach ( )

Set the frame to be an inner frame on the desktop pane

void icy.gui.frame.IcyFrame.center ( )

Center frame on the desktop

void icy.gui.frame.IcyFrame.close ( )

close frame

Reimplemented in icy.gui.frame.progress.TaskFrame.

void icy.gui.frame.IcyFrame.detach ( )

Set the frame to be detached in an independent frame

void icy.gui.frame.IcyFrame.externalize ( )

the frame becomes detached in an independent frame

void icy.gui.frame.IcyFrame.fireFrameExternalized ( IcyFrameEvent  e) [package]

Fire frame externalized event

void icy.gui.frame.IcyFrame.fireFrameInternalized ( IcyFrameEvent  e) [package]

Fire frame internalized event

void icy.gui.frame.IcyFrame.frameClosed ( AWTEvent  e)

internal close stuff

Container icy.gui.frame.IcyFrame.getContentPane ( )

Implement getContentPane method

JMenuItem icy.gui.frame.IcyFrame.getDetachMenuItem ( )
Returns:
the detachMenuItem
int icy.gui.frame.IcyFrame.getHeight ( )

Implement getHeight method

Point icy.gui.frame.IcyFrame.getLocation ( )

Implement getLocation method

Dimension icy.gui.frame.IcyFrame.getMaximumSize ( )

Implement getMaximumSize method

Dimension icy.gui.frame.IcyFrame.getMinimumSize ( )

Implement getMinimumSize method

Point icy.gui.frame.IcyFrame.getMousePosition ( )

Implement getMousePosition method

Container icy.gui.frame.IcyFrame.getParent ( )

Implement getParent

JMenu icy.gui.frame.IcyFrame.getPopupMenu ( )
Returns:
the popupMenu
Dimension icy.gui.frame.IcyFrame.getPreferredSize ( )

Implement getPreferredSize method

JRootPane icy.gui.frame.IcyFrame.getRootPane ( )

Implement getRootPane method

String icy.gui.frame.IcyFrame.getTitle ( )

Implement setTitle method

boolean icy.gui.frame.IcyFrame.getTitleBarVisible ( )

Return true if title bar is visible

Toolkit icy.gui.frame.IcyFrame.getToolkit ( )

Implement getToolkit method

int icy.gui.frame.IcyFrame.getWidth ( )

Implement getWidth method

int icy.gui.frame.IcyFrame.getX ( )

Implement getX method

int icy.gui.frame.IcyFrame.getY ( )

Implement getY method

void icy.gui.frame.IcyFrame.internalize ( )

set the frame to be an inner frame on the desktop pane

boolean icy.gui.frame.IcyFrame.isActive ( )

return true if frame is active

boolean icy.gui.frame.IcyFrame.isExternalized ( )

return true if frame is in externalized state

boolean icy.gui.frame.IcyFrame.isInternalized ( )

return true if frame is in internalized state

boolean icy.gui.frame.IcyFrame.isSyncProcess ( )
Returns:
the syncProcess
boolean icy.gui.frame.IcyFrame.isVisible ( )

Implement isVisible method

void icy.gui.frame.IcyFrame.onClosed ( )
void icy.gui.frame.IcyFrame.pack ( )

Implement pack method

void icy.gui.frame.IcyFrame.remove ( final Component  comp)

Implement remove method

void icy.gui.frame.IcyFrame.removeAll ( )

Implement removeAll method

void icy.gui.frame.IcyFrame.removeFrameListener ( IcyFrameListener  l)

Implement removeFrameListener method

void icy.gui.frame.IcyFrame.removeFrom ( final Container  c)

Remove from the container

void icy.gui.frame.IcyFrame.removeFromMainDesktopPane ( )

Remove the frame from the main pane of ICY

void icy.gui.frame.IcyFrame.removeKeyListener ( KeyListener  l)

Implement addKeyListener method

void icy.gui.frame.IcyFrame.repaint ( )

Implement repaint

void icy.gui.frame.IcyFrame.requestFocus ( )

Frame becomes the active/focused frame

void icy.gui.frame.IcyFrame.revalidate ( )

Implement revalidate

void icy.gui.frame.IcyFrame.setBackground ( final Color  value)

Implement setBackground method

void icy.gui.frame.IcyFrame.setClosable ( final boolean  value)

Implement setClosable method

void icy.gui.frame.IcyFrame.setDefaultCloseOperation ( final int  operation)

Implement setDefaultCloseOperation method

void icy.gui.frame.IcyFrame.setFocusable ( final boolean  value)

Implement setFocusable method

void icy.gui.frame.IcyFrame.setForeground ( final Color  value)

Implement setForeground method

void icy.gui.frame.IcyFrame.setJMenuBar ( final JMenuBar  m)

Implement setJMenuBar method

void icy.gui.frame.IcyFrame.setLayout ( final LayoutManager  layout)

Implement setLayout method

void icy.gui.frame.IcyFrame.setLocation ( final Point  p)

Implement setLocation method

void icy.gui.frame.IcyFrame.setLocation ( final int  x,
final int  y 
)

Implement setLocation method

void icy.gui.frame.IcyFrame.setMaximumSize ( final Dimension  d)

Implement setMaximumSize method

void icy.gui.frame.IcyFrame.setMinimumSize ( final Dimension  d)

Implement setMinimumSize method

void icy.gui.frame.IcyFrame.setPreferredSize ( final Dimension  d)

Implement setPreferredSize method

void icy.gui.frame.IcyFrame.setResizable ( final boolean  value)

Implement setResizable method

void icy.gui.frame.IcyFrame.setSize ( final int  width,
final int  height 
)

Implement setSize method

void icy.gui.frame.IcyFrame.setSize ( final Dimension  d)

Implement setSize method

void icy.gui.frame.IcyFrame.setSyncProcess ( boolean  syncProcess)

By default IcyFrame does asychrone processing, you can force sync processing with this propertie

Parameters:
syncProcessthe syncProcess to set
void icy.gui.frame.IcyFrame.setTitle ( final String  title)

Implement setTitle method

void icy.gui.frame.IcyFrame.setTitleBarVisible ( final boolean  value)

Hide or show the title bar (frame should not be displayable when you set this property)

void icy.gui.frame.IcyFrame.setToolTipText ( final String  text)

Implement setToolTipText method (only for internalized frame)

Reimplemented in icy.gui.frame.progress.ProgressFrame.

void icy.gui.frame.IcyFrame.setVisible ( final boolean  value)

Implement setVisible method

void icy.gui.frame.IcyFrame.switchState ( )

go from detached to attached and opposite

void icy.gui.frame.IcyFrame.toBack ( )

Implement toBack method

void icy.gui.frame.IcyFrame.toFront ( )

Implement toFront method

void icy.gui.frame.IcyFrame.updateUI ( )

Implement updateUI

Reimplemented in icy.gui.plugin.PluginDetailPanel.

void icy.gui.frame.IcyFrame.validate ( )

Implement validate


Member Data Documentation

EventListenerList icy.gui.frame.IcyFrame.frameEventListeners [package]

listeners

ArrayList<IcyFrame> icy.gui.frame.IcyFrame.frames = new ArrayList<IcyFrame>() [static, package]

list containing all active frames

IcyFrameState icy.gui.frame.IcyFrame.state [package]

frame state (internal / external)

sync flag for AWT thread process


The documentation for this class was generated from the following file:
 All Classes Functions Variables