ptolemy.homer.gui

Class HomerMainFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ptolemy.homer.gui.HomerMainFrame

All Implemented Interfaces:

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

public class HomerMainFrame
extends javax.swing.JFrame

The container window for the UI designer that maintains the palette of placeable elements of the model, widget references, and the tabs/scene placement.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Anar Huseynov

See Also:

Serialized Form

Pt.AcceptedRating:

Red (ahuseyno)

Pt.ProposedRating:

Red (ahuseyno)

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.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
HomerMainFrame(HomerApplication application) Create the UI designer frame.

Method Summary

Modifier and Type	Method and Description
void	addLabel(TabScenePanel panel, java.lang.String label, java.awt.Dimension dimension, java.awt.Point point) Add a label to the scene.
void	addNonVisualNamedObject(NamedObj object) Add a non-visual NamedObj item to the panel.
void	addTab(java.lang.String tabName) Add a tab to the screen with the given name.
void	addTab(java.lang.String tabTag, java.lang.String tabName) Add a tab to the screen with the given name and tag.
void	addVisualNamedObject(java.lang.String tag, HomerWidgetElement element) Add a visual NamedObj item to the panel.
void	addVisualNamedObject(TabScenePanel panel, NamedObj object, java.awt.Dimension dimension, java.awt.Point point) Add a visual NamedObj item to the panel.
boolean	contains(NamedObj key) See if the multi-content already has the NamedObj.
java.util.ArrayList<TabDefinition>	getAllTabs() Get all tab definitions.
java.net.URL	getLayoutURL() Get the current layout file URL.
java.net.URL	getModelURL() Get the model URL.
LayoutParser.ScreenOrientation	getOrientation() Get the selected screen orientation.
java.util.HashSet<NamedObj>	getRemoteObjectSet() Get the set of references to on-screen remote objects.
java.awt.Dimension	getScreenSize() Get the screen size.
TabbedLayoutScene	getTabbedLayoutScene() Get the tabbed layout scene.
org.netbeans.api.visual.widget.Scene	getTabContent(java.lang.String tabTag) Get the scene on the tab.
CompositeEntity	getTopLevelActor() Get the top level actor.
static boolean	isLabelWidget(NamedObj object) Return if the object argument is a label widget.
void	newLayout(java.net.URL modelURL) Prepare the scene for creating a new layout and prompt the user for file selection.
void	openLayout(java.net.URL modelURL, java.net.URL layoutURL) Prepare the scene for creating a new layout and prompt the user for file selection.
void	remove(NamedObj object) Remove the NamedObj from the widget map and list of remote objects.
void	removeTab(int index) Remove the tab at the given index.
void	removeVisualNamedObject(PositionableElement element) Remove the visual named object from the scene.
void	saveLayoutAs(java.io.File layoutFile) Save the layout file.
void	setOrientation(LayoutParser.ScreenOrientation orientation) Set the orientation of the scene.
void	setScreenSize(java.awt.Dimension dimension) Set the screen size.
void	setTabTitleAt(int position, java.lang.String text) Set the tab title.

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

HomerMainFrame

public HomerMainFrame(HomerApplication application)

Create the UI designer frame.

Parameters:

application - The application hosting this frame.

Method Detail

addLabel

public void addLabel(TabScenePanel panel,
                     java.lang.String label,
                     java.awt.Dimension dimension,
                     java.awt.Point point)
              throws IllegalActionException,
                     NameDuplicationException

Add a label to the scene.

Parameters:

panel - The panel on which to add the label.

label - The label text.

dimension - The dimensions of the label.

point - The position to place the label.

Throws:

IllegalActionException - If the attribute is not of an acceptable attribute for the container, or if the container is not an instance of Settable.

NameDuplicationException - If the name coincides with an attribute already in the container.

addNonVisualNamedObject

public void addNonVisualNamedObject(NamedObj object)

Add a non-visual NamedObj item to the panel.

Parameters:

object - The NamedObj to be added to the list.

addTab

public void addTab(java.lang.String tabName)

Add a tab to the screen with the given name.

Parameters:

tabName - The name of the tab.

addTab

public void addTab(java.lang.String tabTag,
                   java.lang.String tabName)

Add a tab to the screen with the given name and tag.

Parameters:

tabTag - The tag of the tab.

tabName - The name of the tab.

addVisualNamedObject

public void addVisualNamedObject(java.lang.String tag,
                                 HomerWidgetElement element)
                          throws IllegalActionException

Add a visual NamedObj item to the panel.

Parameters:

tag - The tag associated with the element.

element - The NamedObj to be added.

Throws:

IllegalActionException - If the content area is not set.

addVisualNamedObject

public void addVisualNamedObject(TabScenePanel panel,
                                 NamedObj object,
                                 java.awt.Dimension dimension,
                                 java.awt.Point point)
                          throws IllegalActionException,
                                 NameDuplicationException

Add a visual NamedObj item to the panel.

Parameters:

panel - The target panel.

object - The NamedObj to be added to the list.

dimension - The size of the widget.

point - Location on the scene.

Throws:

IllegalActionException - If the appropriate widget cannot be loaded.

NameDuplicationException - If the NamedObj duplicates a name of an item already on the scene.

contains

public boolean contains(NamedObj key)

See if the multi-content already has the NamedObj.

Parameters:

key - The NamedObj to check existence.

Returns:

If the NamedObj is in the content.

getAllTabs

public java.util.ArrayList<TabDefinition> getAllTabs()

Get all tab definitions.

Returns:

The tab definitions of the window.

getLayoutURL

public java.net.URL getLayoutURL()

Get the current layout file URL.

Returns:

The current layout file URL.

getModelURL

public java.net.URL getModelURL()

Get the model URL.

Returns:

The model URL.

getOrientation

public LayoutParser.ScreenOrientation getOrientation()

Get the selected screen orientation.

Returns:

The screen orientation.

See Also:

setOrientation(ptolemy.homer.kernel.LayoutParser.ScreenOrientation)

getRemoteObjectSet

public java.util.HashSet<NamedObj> getRemoteObjectSet()

Get the set of references to on-screen remote objects.

Returns:

The set of remote object references.

getScreenSize

public java.awt.Dimension getScreenSize()

Get the screen size.

Returns:

The size of the scene.

See Also:

setScreenSize(Dimension)

getTabbedLayoutScene

public TabbedLayoutScene getTabbedLayoutScene()

Get the tabbed layout scene.

Returns:

The reference to the tabbed area of the screen.

getTabContent

public org.netbeans.api.visual.widget.Scene getTabContent(java.lang.String tabTag)

Get the scene on the tab.

Parameters:

tabTag - The tag of the tab being retrieved.

Returns:

The scene on the selected tab.

newLayout

public void newLayout(java.net.URL modelURL)

Prepare the scene for creating a new layout and prompt the user for file selection.

Parameters:

modelURL - The url of the model file to be opened.

openLayout

public void openLayout(java.net.URL modelURL,
                       java.net.URL layoutURL)

Prepare the scene for creating a new layout and prompt the user for file selection.

Parameters:

modelURL - The url of the model file to be opened.

layoutURL - The url of the layout file to be opened.

remove

public void remove(NamedObj object)

Remove the NamedObj from the widget map and list of remote objects.

Parameters:

object - The NamedObj item to be removed.

removeTab

public void removeTab(int index)

Remove the tab at the given index.

Parameters:

index - The tab index to be removed.

removeVisualNamedObject

public void removeVisualNamedObject(PositionableElement element)

Remove the visual named object from the scene.

Parameters:

element - The screen element to be removed.

saveLayoutAs

public void saveLayoutAs(java.io.File layoutFile)

Save the layout file.

Parameters:

layoutFile - The target file for the "Save As" operation.

setOrientation

public void setOrientation(LayoutParser.ScreenOrientation orientation)

Set the orientation of the scene.

Parameters:

orientation - The orientation of the scene.

See Also:

getOrientation()

setScreenSize

public void setScreenSize(java.awt.Dimension dimension)

Set the screen size.

Parameters:

dimension - The screen size.

See Also:

getScreenSize()

setTabTitleAt

public void setTabTitleAt(int position,
                          java.lang.String text)

Set the tab title.

Parameters:

position - The tab index being changed.

text - The new tab text.

isLabelWidget

public static boolean isLabelWidget(NamedObj object)

Return if the object argument is a label widget. A label widget is an object that is an Attribute that contains a HomerConstants.TAB_NODE and the value of the TAB_NODE is the name of the container of the object.

Parameters:

object - The object to be checked.

Returns:

If the value of the object argument is a label widget.

getTopLevelActor

public CompositeEntity getTopLevelActor()

Get the top level actor.

Returns:

The top level actor.