icy.gui.main

Class MainFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.pushingpixels.flamingo.api.ribbon.JRibbonFrame

icy.gui.main.MainFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class MainFrame
extends org.pushingpixels.flamingo.api.ribbon.JRibbonFrame

Author:

fab & Stephane

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_PREVIOUS_STATE
static java.lang.String	PROPERTY_DETACHEDMODE
static int	TILE_GRID
static int	TILE_HORIZONTAL
static int	TILE_VERTICAL
static java.lang.String	TITLE

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
MainFrame()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	externalizeInspector() Externalize the inspector in main container.
ApplicationMenu	getApplicationMenu()
javax.swing.JPanel	getCenterPanel() Returns the center pane, this pane contains the desktop pane.
ChatPanel	getChat() Deprecated. IRC has been removed since Icy 1.9.8.0
int	getDesktopHeight() Return content pane height
IcyDesktopPane	getDesktopPane() Returns the desktopPane which contains InternalFrame.
java.awt.Dimension	getDesktopSize() Return content pane dimension (available area in main frame).
int	getDesktopWidth() Return content pane width
static Viewer[]	getExternalViewers(boolean wantNotVisible, boolean wantIconized) Returns the list of internal viewers.
static Viewer[]	getExternalViewers(java.awt.Rectangle bounds, boolean wantNotVisible, boolean wantIconized) Returns the list of internal viewers.
InspectorPanel	getInspector()
java.util.ArrayList<javax.swing.JInternalFrame>	getInternalFrames() Return all internal frames
MainRibbon	getMainRibbon()
int	getPreviousHeight()
boolean	getPreviousMaximized()
SearchBar	getSearchBar() Returns the SearchBar component.
void	init() Process init.
boolean	internalizeInspector() Internalize the inspector in main container.
boolean	isDetachedMode() Return true if the main frame is in "detached" mode
boolean	isInpectorInternalized() Returns true if the inspector is internalized in main container.
void	organizeCascade() Organize all frames in cascade
void	organizeTile(int type) Organize all frames in tile.
void	refreshTitle() Refresh application title
void	reshape(int x, int y, int width, int height)
void	setDetachedMode(boolean value) Set detached window mode.

Methods inherited from class org.pushingpixels.flamingo.api.ribbon.JRibbonFrame

dispose, getApplicationIcon, getRibbon, isShowingKeyTips, setApplicationIcon, setContentPane, setIconImages, setJMenuBar, setLayout

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setLayeredPane, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

PROPERTY_DETACHEDMODE

public static final java.lang.String PROPERTY_DETACHEDMODE

See Also:

Constant Field Values

TILE_HORIZONTAL

public static final int TILE_HORIZONTAL

See Also:

Constant Field Values

TILE_VERTICAL

public static final int TILE_VERTICAL

See Also:

Constant Field Values

TILE_GRID

public static final int TILE_GRID

See Also:

Constant Field Values

ID_PREVIOUS_STATE

public static final java.lang.String ID_PREVIOUS_STATE

See Also:

Constant Field Values

Constructor Detail

MainFrame

public MainFrame()
          throws java.awt.HeadlessException

Throws:

java.awt.HeadlessException

Method Detail

getExternalViewers

public static Viewer[] getExternalViewers(java.awt.Rectangle bounds,
                          boolean wantNotVisible,
                          boolean wantIconized)

Returns the list of internal viewers.

Parameters:

bounds - If not null only viewers visible in the specified bounds are returned.

wantNotVisible - Also return not visible viewers

wantIconized - Also return iconized viewers

getExternalViewers

public static Viewer[] getExternalViewers(boolean wantNotVisible,
                          boolean wantIconized)

Returns the list of internal viewers.

Parameters:

wantNotVisible - Also return not visible viewers

wantIconized - Also return iconized viewers

init

public void init()

Process init.
Inspector is an ExternalizablePanel and requires MainFrame to be created.

getApplicationMenu

public ApplicationMenu getApplicationMenu()

getCenterPanel

public javax.swing.JPanel getCenterPanel()

Returns the center pane, this pane contains the desktop pane.
Feel free to add temporary top/left/right or bottom pane to it.

getSearchBar

public SearchBar getSearchBar()

Returns the SearchBar component.

getDesktopPane

public IcyDesktopPane getDesktopPane()

Returns the desktopPane which contains InternalFrame.

getInternalFrames

public java.util.ArrayList<javax.swing.JInternalFrame> getInternalFrames()

Return all internal frames

getInspector

public InspectorPanel getInspector()

Returns:

the inspector

getMainRibbon

public MainRibbon getMainRibbon()

Returns:

the mainRibbon

getChat

public ChatPanel getChat()

Deprecated. IRC has been removed since Icy 1.9.8.0

isDetachedMode

public boolean isDetachedMode()

Return true if the main frame is in "detached" mode

getDesktopSize

public java.awt.Dimension getDesktopSize()

Return content pane dimension (available area in main frame).
If the main frame is in "detached" mode this actually return the system desktop dimension.

getDesktopWidth

public int getDesktopWidth()

Return content pane width

getDesktopHeight

public int getDesktopHeight()

Return content pane height

getPreviousHeight

public int getPreviousHeight()

getPreviousMaximized

public boolean getPreviousMaximized()

isInpectorInternalized

public boolean isInpectorInternalized()

Returns true if the inspector is internalized in main container.
Always returns false in detached mode.

internalizeInspector

public boolean internalizeInspector()

Internalize the inspector in main container.
The method fails and returns false in detached mode.

externalizeInspector

public boolean externalizeInspector()

Externalize the inspector in main container.
Returns false if the methods failed.

organizeCascade

public void organizeCascade()

Organize all frames in cascade

organizeTile

public void organizeTile(int type)

Organize all frames in tile.

Parameters:

type - tile type.
TILE_HORIZONTAL, TILE_VERTICAL or TILE_GRID.

setDetachedMode

public void setDetachedMode(boolean value)

Set detached window mode.

refreshTitle

public void refreshTitle()

Refresh application title

reshape

public void reshape(int x,
           int y,
           int width,
           int height)

Overrides:

reshape in class java.awt.Window