ilog.views.dashboard

Class IlvDashboardEditorFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ilog.views.dashboard.IlvDashboardEditorFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class IlvDashboardEditorFrame
extends JFrame

IlvDashboardEditorFrame defines the areas inside a Java Swing JFrame used to house different components in a Dashboard Editor application.

The Editor Frame Layout

The following table shows the structure of a IlvDashboardEditorFrame. Inside each pane is a list of the components used in the Dashboard Editor example.

IlvDashboardEditBar, IlvDiagrammerViewBar, IlvDashboardBackgroundBar
IlvDashboardTree	IlvDashboardTabbedPane	IlvDiagrammerOverview
IlvDashboardPropertyPanel		IlvDashboardSymbolPalette
IlvDashboardDefaultStatusViewer

Each pane in a IlvDashboardEditorFrame instance is a Swing JComponent.

Adding Dashboard Components

The following example shows how to add Dashboard Editor components to a JComponent object before being adding to a IlvDashboardEditorFrame.

  public class DashboardEditor extends IlvDashboardEditor {
    IlvDashboardEditorFrame frame;
    ...
    IlvDashboardMenuBar menuBar = new IlvDashboardMenuBar(this);
    frame = getFrame();
    JPanel panel = new JPanel(new BorderLayout());
    JPanel panel1 = new JPanel(new IlvBetterFlowLayout(FlowLayout.LEADING, 0, 0));
    IlvDashboardEditBar editToolBar = new IlvDashboardEditBar();
    panel1.add(editToolBar);
    IlvDiagrammerViewBar viewToolBar = new IlvDiagrammerViewBar();
    panel1.add(viewToolBar);    
    panel.add(panel1, BorderLayout.PAGE_START);
    
    final IlvDashboardBackgroundBar paletteToolBar = new IlvDashboardBackgroundBar(this);
    panel.add(paletteToolBar, BorderLayout.PAGE_END);
    frame.setTopToolBarArea(panel);
  

Adding Dashboard Menu Bars

The following code example shows how to add a Dashboard Editor menu bar to a IlvDashboardEditorFrame instance.

  public class DashboardEditor extends IlvDashboardEditor {
    IlvDashboardEditorFrame frame;
    ...
    IlvDashboardMenuBar menuBar = new IlvDashboardMenuBar(this);
    frame = getFrame();
    frame.setJMenuBar(menuBar);
    ...
 

Since:

JViews 8.0

See Also:

IlvDashboardEditor, IlvDashboardEditBar, IlvDashboardTree, IlvDashboardTabbedPane, IlvDiagrammerOverview, IlvDashboardPropertyPanel, IlvDashboardExpandablePane, IlvDashboardDefaultStatusViewer, IlvDashboardAction, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

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
IlvDashboardEditorFrame(IlvDashboardEditor editor) Constructs an IlvDashboardEditorFrame object for a given IlvDashboardEditor instance.

Method Summary

Modifier and Type	Method and Description
JComponent	getCenterArea() Returns the Dashboard Editor component in the center pane of this IlvDashboardEditorFrame.
IlvDashboardEditor	getEditor() Returns the IlvDashboardEditor object in a IlvDashboardEditorFrame instance.
JComponent	getLeftArea() Returns the element holding Dashboard Editor components in the left pane of this IlvDashboardEditorFrame.
JComponent	getRightArea() Returns the element holding Dashboard Editor components in the right pane of this IlvDashboardEditorFrame.
JComponent	getStatusBar() Returns the status bar component for this IlvDashboardEditorFrame.
JComponent	getTopToolBarArea() Returns the component stored in the toolbar of this IlvDashboardEditorFrame instance.
void	savePreferences() Invoked by the Dashboard Editor to save the user preferences before exiting the session.
void	setCenterArea(JComponent component) Sets the component of center pane of this IlvDashboardEditorFrame.
void	setLeftArea(JComponent component) Sets the component of left pane of this IlvDashboardEditorFrame.
void	setRightArea(JComponent component) Sets the component of right pane of this IlvDashboardEditorFrame.
void	setStatusBar(JComponent component) Sets the status bar component of this IlvDashboardEditorFrame.
void	setTopToolBarArea(JComponent component) Sets the component stored in the toolbar of this IlvDashboardEditorFrame.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, 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, dispose, 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, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, 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, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, 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

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

IlvDashboardEditorFrame

public IlvDashboardEditorFrame(IlvDashboardEditor editor)

Constructs an IlvDashboardEditorFrame object for a given IlvDashboardEditor instance.

Parameters:

editor - The Dashboard Editor for which this frame is created.

See Also:

Initializing a IlvDashboardEditorFrame

Method Detail

getEditor

public IlvDashboardEditor getEditor()

Returns the IlvDashboardEditor object in a IlvDashboardEditorFrame instance.

Returns:

The central IlvDashboardEditor component.

getTopToolBarArea

public JComponent getTopToolBarArea()

Returns the component stored in the toolbar of this IlvDashboardEditorFrame instance.

By default, this area holds a JPanel containing a IlvDashboardEditBar, IlvDiagrammerViewBar, and IlvDashboardBackgroundBar instance.

Returns:

The component stored in the toolbar of this IlvDashboardEditorFrame instance.

See Also:

IlvDashboardEditorFrame pane layout, IlvDashboardEditBar, IlvDiagrammerViewBar, IlvDashboardBackgroundBar

setTopToolBarArea

public void setTopToolBarArea(JComponent component)

Sets the component stored in the toolbar of this IlvDashboardEditorFrame.

By default, this area holds a JPanel containing horizontal toolbars. Examples of this are IlvDashboardEditBar, IlvDiagrammerViewBar, and IlvDashboardBackgroundBar.

Parameters:

component - A JComponent containing toolbars.

See Also:

IlvDashboardEditorFrame pane layout, IlvDashboardEditBar, IlvDiagrammerViewBar, IlvDashboardBackgroundBar

getStatusBar

public JComponent getStatusBar()

Returns the status bar component for this IlvDashboardEditorFrame.

Returns:

The status bar component of this IlvDashboardEditorFrame.

See Also:

IlvDashboardEditorFrame pane layout, IlvDashboardDefaultStatusViewer

setStatusBar

public void setStatusBar(JComponent component)

Sets the status bar component of this IlvDashboardEditorFrame.

By default, a IlvDashboardDefaultStatusViewer is used to display messages in the status bar.

Parameters:

component - A status bar component.

See Also:

IlvDashboardEditorFrame pane layout, IlvDashboardDefaultStatusViewer

setLeftArea

public void setLeftArea(JComponent component)

Sets the component of left pane of this IlvDashboardEditorFrame.

By default, this area holds a IlvDashboardExpandableSplitPane containing a IlvDashboardTree and a IlvDiagrammerPropertySheet. The following code example shows how to add Dashboard Editor components to the left pane.

 public class DashboardEditor extends IlvDashboardEditor {
   private IlvDashboardEditorFrame frame;
   ...
   frame = getFrame(); 
   URL url = IlvDiagrammerTree.class.getResource("images/tree.gif");
   ImageIcon icon = new ImageIcon(url);
   IlvDashboardTree tree = new IlvDashboardTree();
   JScrollPane treeScrollPane = new JScrollPane(tree);
   IlvDashboardExpandablePane treeFrame = 
                  new IlvDashboardExpandablePane("Tree", icon, treeScrollPane);
 
   url = IlvDiagrammerPropertySheet.class.getResource("images/psheet.gif");
   icon = new ImageIcon(url);
   IlvDashboardPropertyPanel ppanel = new IlvDashboardPropertyPanel(this);
   IlvDashboardExpandablePane psheetFrame = 
                  new IlvDashboardExpandablePane("Property Sheet", icon, ppanel);
                      
   IlvDashboardExpandableSplitPane split = 
                  new IlvDashboardExpandableSplitPane(treeFrame, psheetFrame);
   split.setResizeWeight(0.5);
   split.setDividerLocation(300);
   frame.setLeftArea(split);
 

Parameters:

component - A JComponent containing Dashboard Editor components.

See Also:

IlvDashboardEditorFrame pane layout, getLeftArea(), IlvDashboardExpandableSplitPane, IlvDashboardExpandablePane, IlvDashboardTree, IlvDiagrammerPropertySheet

getLeftArea

public JComponent getLeftArea()

Returns the element holding Dashboard Editor components in the left pane of this IlvDashboardEditorFrame.

Returns:

The components in the left pane of this IlvDashboardEditorFrame.

See Also:

IlvDashboardEditorFrame pane layout, setLeftArea(JComponent), IlvDashboardExpandableSplitPane, IlvDashboardExpandablePane, IlvDashboardTree, IlvDiagrammerPropertySheet

getRightArea

public JComponent getRightArea()

Returns the element holding Dashboard Editor components in the right pane of this IlvDashboardEditorFrame.

Returns:

The components in the right pane of this IlvDashboardEditorFrame.

See Also:

IlvDashboardEditorFrame pane layout, setRightArea(JComponent), IlvDashboardExpandableSplitPane, IlvDashboardSymbolPalette, IlvDiagrammerOverview, IlvDashboardExpandablePane, IlvDiagrammerPropertySheet

setRightArea

public void setRightArea(JComponent component)

Sets the component of right pane of this IlvDashboardEditorFrame.

By default, this area holds a IlvDashboardExpandableSplitPane containing a IlvDashboardSymbolPalette and a IlvDiagrammerOverview. The following code example shows how to add Dashboard Editor components to the right pane.

 public class DashboardEditor extends IlvDashboardEditor {
   private IlvDashboardEditorFrame frame;
   ...
   frame = getFrame(); 
   URL url = IlvDiagrammerOverview.class.getResource("images/overview.gif");
   ImageIcon icon = new ImageIcon(url);
   IlvDiagrammerOverview overview = new IlvDiagrammerOverview();
   IlvDashboardExpandablePane overviewFrame = 
            new IlvDashboardExpandablePane("Overview", icon, overview);
 
   url = IlvDiagrammerPropertySheet.class.getResource("images/psheet.gif");
   icon = new ImageIcon(url);
   IlvDashboardSymbolPalette palettePanel = new IlvDashboardSymbolPalette(this);
   IlvDashboardExpandablePane paletteFrame = 
            new IlvDashboardExpandablePane("Palette", icon, palettePanel);

   IlvDashboardExpandableSplitPane split = 
            new IlvDashboardExpandableSplitPane(overviewFrame, paletteFrame);
   split.setResizeWeight(0.75);
   split.setDividerLocation(150);
   frame.setRightArea(split);
 

Parameters:

component - A JComponent containing Dashboard Editor components.

See Also:

IlvDashboardEditorFrame pane layout, getRightArea(), IlvDashboardExpandableSplitPane, IlvDashboardSymbolPalette, IlvDiagrammerOverview, IlvDashboardExpandablePane, IlvDiagrammerPropertySheet

getCenterArea

public JComponent getCenterArea()

Returns the Dashboard Editor component in the center pane of this IlvDashboardEditorFrame.

Returns:

The components in the center pane of this IlvDashboardEditorFrame.

See Also:

IlvDashboardEditorFrame pane layout, setCenterArea(JComponent), IlvDashboardTabbedPane

setCenterArea

public void setCenterArea(JComponent component)

Sets the component of center pane of this IlvDashboardEditorFrame.

By default, this area holds a IlvDashboardTabbedPane. The following code example shows how to add Dashboard Editor components to the center pane.

  public class DashboardEditor extends IlvDashboardEditor {
   private IlvDashboardEditorFrame frame;
   ...
   frame = getFrame(); 
   IlvDashboardTabbedPane dtp = new IlvDashboardTabbedPane();
   frame.setCenterArea(dtp);
   setDashboardContainer(dtp);
 

Parameters:

component - The center area component.

See Also:

IlvDashboardEditorFrame pane layout, getCenterArea(), IlvDashboardTabbedPane

savePreferences

public void savePreferences()

Invoked by the Dashboard Editor to save the user preferences before exiting the session.

Since:

JViews 8.5