Class NetEditorFrame
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
fr.esrf.tangoatk.widget.util.interlock.NetEditorFrame
- All Implemented Interfaces:
NetEditorListener,ActionListener,ImageObserver,MenuContainer,Serializable,EventListener,Accessible,RootPaneContainer,WindowConstants
- Direct Known Subclasses:
ItlkEditor
A Frame for the NetEditor. This class is a good base class to create
specific network editor. By default, It constructs all menus needed by
the NetEditor and its toolbar.
All actions are handled by this frame. So you can override actionPerformed() to get the control on a menu item or a button. Ex: overriding the 'load' menu item action
public void actionPerformed(ActionEvent evt) {
if( evt.getSource() == getFileMenuItem(NetEditorFrame.FILE_LOAD) ) {
...
} else {
super.actionPerformed(evt);
}
}
You can also add or remove menu items or toolbar buttons. Here is an example of code that customize the option menu :
traceMode = NetUtils.createMenuItem("Trace mode",0,0,this);
editMode = NetUtils.createMenuItem("Edit mode",0,0,this);
getOptionMenu().add(traceMode,0);
getOptionMenu().add(editMode,1);
getOptionMenu().add(new JSeparator(),2);
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrameNested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrameNested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.TypeNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class javax.swing.JFrame
accessibleContext, rootPane, rootPaneCheckingEnabledFields 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_CURSORFields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidcancelCreate(NetEditor src) Clear the help label when the creation mode is abortedcreateIconButton(String resPath, String preffix, String toolTip, ActionListener l) Create an icon button.voidexitApp()Ask to save if the current scheme has unsaved modification before exiting.getEditMenuItem(int which) getFileMenuItem(int which) getOptionMenuItem(int which) getToobarButton(int which) voidlinkClicked(NetEditor src, NetObject obj, int childIdx, MouseEvent e) Trigerred when the user click on a link if the editor is not editable.voidLoad a file into the editorstatic voidvoidobjectClicked(NetEditor src, NetObject obj, MouseEvent e) Trigerred when the user click on an object only if the editor is not editable.voidsetAppTitle(String appName) Sets the app name used to build the frame title.voidSets the NetEditor.voidsizeChanged(NetEditor src, Dimension d) Revalidate the inner ScrollPanevoidvalueChanged(NetEditor src) Update the title bar with the filename and the apptitle when the scheme change .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, updateMethods 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, setUndecoratedMethods 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, toFrontMethods 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, validateTreeMethods 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.awt.MenuContainer
getFont, postEvent
-
Field Details
-
FILE_NEW
public static final int FILE_NEW- See Also:
-
FILE_LOAD
public static final int FILE_LOAD- See Also:
-
FILE_SAVE
public static final int FILE_SAVE- See Also:
-
FILE_SAVEAS
public static final int FILE_SAVEAS- See Also:
-
FILE_EXIT
public static final int FILE_EXIT- See Also:
-
EDIT_UNDO
public static final int EDIT_UNDO- See Also:
-
EDIT_REDO
public static final int EDIT_REDO- See Also:
-
EDIT_CUT
public static final int EDIT_CUT- See Also:
-
EDIT_COPY
public static final int EDIT_COPY- See Also:
-
EDIT_PASTE
public static final int EDIT_PASTE- See Also:
-
EDIT_DELETE
public static final int EDIT_DELETE- See Also:
-
EDIT_SELECT_ALL
public static final int EDIT_SELECT_ALL- See Also:
-
EDIT_SELECT_NONE
public static final int EDIT_SELECT_NONE- See Also:
-
OPTION_FIT
public static final int OPTION_FIT- See Also:
-
OPTION_PREF
public static final int OPTION_PREF- See Also:
-
TOOL_BUBBLE
public static final int TOOL_BUBBLE- See Also:
-
TOOL_LABEL
public static final int TOOL_LABEL- See Also:
-
TOOL_LINK
public static final int TOOL_LINK- See Also:
-
TOOL_UNDO
public static final int TOOL_UNDO- See Also:
-
TOOL_REDO
public static final int TOOL_REDO- See Also:
-
-
Constructor Details
-
NetEditorFrame
public NetEditorFrame()Construct a frame for the NetEditor.
-
-
Method Details
-
setEditor
Sets the NetEditor.- Parameters:
editor- NetEditor object
-
setAppTitle
Sets the app name used to build the frame title.- Parameters:
appName- application name- See Also:
-
getFileMenu
- Returns:
- the file menu.
-
getFileMenuItem
- Parameters:
which- Menu identifier- Returns:
- a reference to the specified menu item of the file menu.
- See Also:
-
getEditMenu
- Returns:
- the edit menu.
-
getEditMenuItem
- Parameters:
which- Menu identifier- Returns:
- a reference to the specified menu item of the edit menu.
- See Also:
-
getOptionMenu
- Returns:
- the option menu.
-
getOptionMenuItem
- Parameters:
which- Menu identifier- Returns:
- a reference to the specified menu item of the option menu.
- See Also:
-
getToolbar
- Returns:
- the default toolbar
-
getToobarButton
- Parameters:
which- Button identifier- Returns:
- a reference to the specified button of the toolbar.
- See Also:
-
loadFile
Load a file into the editor- Parameters:
fileName- File name
-
getHelpLabel
- Returns:
- a reference to the help label
-
getScrollPane
- Returns:
- the JScrollPane that contains the NetEditor object
-
exitApp
public void exitApp()Ask to save if the current scheme has unsaved modification before exiting. -
createIconButton
Create an icon button. The function laods 3 gif files from the resource. They must be named "preffix_btn_up.gif" , "preffix_btn_down.gif" and "preffix_btn_dis.gif".- Parameters:
resPath- Resource path (ended with a '/')preffix- Preffix of gif filestoolTip- Tooltip textl- ActionListener- Returns:
- an icon JButton
-
valueChanged
Update the title bar with the filename and the apptitle when the scheme change . Update also the state of menu and icon according to the editor (clipboard,selection,...)- Specified by:
valueChangedin interfaceNetEditorListener- Parameters:
src- NetEditor- See Also:
-
objectClicked
Description copied from interface:NetEditorListenerTrigerred when the user click on an object only if the editor is not editable.- Specified by:
objectClickedin interfaceNetEditorListener- Parameters:
src- NetEditor that has trigerred the event.obj- Clicked object.e- Original MouseEvent- See Also:
-
linkClicked
Description copied from interface:NetEditorListenerTrigerred when the user click on a link if the editor is not editable.- Specified by:
linkClickedin interfaceNetEditorListener- Parameters:
src- NetEditor that has trigerred the event.obj- Clicked object.childIdx- Child index.e- Original MouseEvent- See Also:
-
sizeChanged
Revalidate the inner ScrollPane- Specified by:
sizeChangedin interfaceNetEditorListener- Parameters:
src- NetEditor that has trigerred the event.d- New dimension (in pixel coordinates)- See Also:
-
cancelCreate
Clear the help label when the creation mode is aborted- Specified by:
cancelCreatein interfaceNetEditorListener- Parameters:
src- NetEditor that has trigerred the event.- See Also:
-
actionPerformed
- Specified by:
actionPerformedin interfaceActionListener
-
main
-