com.jstatcom.equation
Class EqTermDefault

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jstatcom.equation.EqTerm
                      com.jstatcom.equation.EqTermDefault

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

EqTermLHS

public class EqTermDefault
extends EqTerm
implements java.beans.PropertyChangeListener

Default implementation of EqTerm.

Author:

A. Benkwitz, Markus Kraetzig

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

EqTermDefault()
Default constructor that sets submatrix index to -1 and lag index to 0.

EqTermDefault(int subMatrixIndex)
Creates an EqTermDefault for a sub matrix index.

EqTermDefault(int subMatrixIndex, int lagIndex)
Creates an EqTermDefault for a sub matrix index and a lag index.

Method Summary

int	getColumnWidth() Gets the column width of the underlying coefficients table.
int	getLagIndex() Gets the index for the lag.
java.awt.event.MouseListener	getMouseListenerCoeff() Gets the mouse listener set for the coefficients table.
int	getPrecision() Gets the precision of the underlying coefficients table.
javax.swing.table.TableCellRenderer	getRendererCoeff() Gets the cell renderer of the underlying coefficients table.
java.lang.String	getSymbolNameCoeff() Gets the symbol name for the coefficients.
java.lang.String	getSymbolNameSubsetRes() Gets the symbol name for the subset restrictions that are set for the coefficients.
java.lang.String	getSymbolNameVariables() Gets the symbol name for the variable names corresponding to the coefficients.
javax.swing.JPopupMenu	getTablePopup() Gets the popup menu that is set for the underlying coefficients table.
boolean	isCoeffMatRequired() Gets whether a coefficients matrix is required to display this equation term.
boolean	isEditable() Gets whether the underlying coefficients table is editable.
boolean	isMatrixCentered() Gets whether the matrix displaying the coefficients is centered in the term.
boolean	isShowingTimeIndex() Gets whether the variable names vector should have a time index to indicate the lag, for example income(t) or income(t-1).
void	propertyChange(java.beans.PropertyChangeEvent evt) Manages visibility of this component with respect to the available coefficients and the coeffMatRequired property.
void	setCoeffMatRequired(boolean isCoeffMatRequired) Sets whether a coefficients matrix is required to display this equation term.
void	setColumnWidth(int colWidth) Sets the column width of the underlying coefficients table.
void	setEditable(boolean isEditable) Sets whether the underlying coefficients table is editable.
void	setLagIndex(int index) Sets the lag index of this equation term.
void	setLeadingSignVisible(boolean isVisible) Manages visibility of the leading sign label.
void	setMatrixCentered(boolean centered) Sets whether the matrix displaying the coefficients is centered in the term.
void	setMouseListenerCoeff(java.awt.event.MouseListener listener) Sets the mouse listener for the underlying coefficients table.
void	setPrecision(int precision) Sets the precision for the underlying coefficients table.
void	setRendererCoeff(javax.swing.table.TableCellRenderer renderer) Sets the cell renderer for the underlying coefficients table.
void	setShowingTimeIndex(boolean isShowingTimeIndex) Sets whether the variable names vector should have a time index to indicate the lag, for example income(t) or income(t-1).
void	setSymbolNameCoeff(java.lang.String symbolName) Sets the symbol name for the coefficients.
void	setSymbolNameSubsetRes(java.lang.String symbolName) Sets the symbol name for the subset restrictions that are set for the coefficients.
void	setSymbolNameVariables(java.lang.String symbolName) Sets the symbol name ffor the variable names corresponding to the coefficients.
void	setSymbolScope(Scope scope) Sets the symbol scope, which defines which symbol table to use (local, global or upper).
void	setTablePopup(javax.swing.JPopupMenu newTablePopup) Sets the popup menu for the underlying coefficients tables.

Methods inherited from class com.jstatcom.equation.EqTerm

getMaximumSize, getMinimumSize, getPreferredSize, getSymbolScope, setDataAvailable, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

EqTermDefault

public EqTermDefault()

Default constructor that sets submatrix index to -1 and lag index to 0.

EqTermDefault

public EqTermDefault(int subMatrixIndex)

Creates an EqTermDefault for a sub matrix index. The lag index is set to 0.

Parameters:

subMatrixIndex - the index in the sub matrix model

EqTermDefault

public EqTermDefault(int subMatrixIndex,
                     int lagIndex)

Creates an EqTermDefault for a sub matrix index and a lag index.

Parameters:

subMatrixIndex - the index in the sub matrix model

lagIndex - the index for the lag

Method Detail

getColumnWidth

public int getColumnWidth()

Gets the column width of the underlying coefficients table.

Returns:

column width

getLagIndex

public int getLagIndex()

Gets the index for the lag.

Returns:

lag index

getMouseListenerCoeff

public java.awt.event.MouseListener getMouseListenerCoeff()

Gets the mouse listener set for the coefficients table.

Returns:

java.awt.event.MouseListener

getPrecision

public int getPrecision()

Gets the precision of the underlying coefficients table.

Returns:

precision

getRendererCoeff

public javax.swing.table.TableCellRenderer getRendererCoeff()

Gets the cell renderer of the underlying coefficients table.

Returns:

javax.swing.table.TableCellRenderer

getSymbolNameCoeff

public java.lang.String getSymbolNameCoeff()

Gets the symbol name for the coefficients.

Returns:

symbol name

getSymbolNameSubsetRes

public java.lang.String getSymbolNameSubsetRes()

Gets the symbol name for the subset restrictions that are set for the coefficients.

Returns:

symbol name

getSymbolNameVariables

public java.lang.String getSymbolNameVariables()

Gets the symbol name for the variable names corresponding to the coefficients.

Returns:

symbol name

getTablePopup

public javax.swing.JPopupMenu getTablePopup()

Gets the popup menu that is set for the underlying coefficients table.

Returns:

popup menu

isCoeffMatRequired

public boolean isCoeffMatRequired()

Gets whether a coefficients matrix is required to display this equation term. It might be false to just display variable names, for example for the residuals.

Returns:

true if coefficients are required

isEditable

public boolean isEditable()

Gets whether the underlying coefficients table is editable.

Returns:

true if editable

isMatrixCentered

public boolean isMatrixCentered()

Gets whether the matrix displaying the coefficients is centered in the term. This is not true for an EC term, for example.

Returns:

true if centered

isShowingTimeIndex

public boolean isShowingTimeIndex()

Gets whether the variable names vector should have a time index to indicate the lag, for example income(t) or income(t-1). This should be false for deterministic variables.

Returns:

true if time index shown

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Manages visibility of this component with respect to the available coefficients and the coeffMatRequired property.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - property change event

setCoeffMatRequired

public void setCoeffMatRequired(boolean isCoeffMatRequired)

Sets whether a coefficients matrix is required to display this equation term. It might be false to just display variable names, for example for the residuals.

Parameters:

isCoeffMatRequired - true if coefficients are required

setColumnWidth

public void setColumnWidth(int colWidth)

Sets the column width of the underlying coefficients table.

Parameters:

colWidth - column width

setEditable

public void setEditable(boolean isEditable)

Sets whether the underlying coefficients table is editable.

Parameters:

isEditable - true if editable

setLagIndex

public void setLagIndex(int index)

Sets the lag index of this equation term. It determines how the time index is created for the variables.

Parameters:

index - lag

setLeadingSignVisible

public void setLeadingSignVisible(boolean isVisible)

Manages visibility of the leading sign label.

Specified by:

setLeadingSignVisible in class EqTerm

Parameters:

isVisible - true if visible

setMatrixCentered

public void setMatrixCentered(boolean centered)

Sets whether the matrix displaying the coefficients is centered in the term. This is not true for an EC term, for example.

Parameters:

centered - true if centered

setMouseListenerCoeff

public void setMouseListenerCoeff(java.awt.event.MouseListener listener)

Sets the mouse listener for the underlying coefficients table.

Parameters:

listener - java.awt.event.MouseListener

setPrecision

public void setPrecision(int precision)

Sets the precision for the underlying coefficients table.

Parameters:

precision -

setRendererCoeff

public void setRendererCoeff(javax.swing.table.TableCellRenderer renderer)

Sets the cell renderer for the underlying coefficients table.

Parameters:

renderer - javax.swing.table.TableCellRenderer

setShowingTimeIndex

public void setShowingTimeIndex(boolean isShowingTimeIndex)

Sets whether the variable names vector should have a time index to indicate the lag, for example income(t) or income(t-1). This should be false for deterministic variables.

Parameters:

isShowingTimeIndex - true if time index shown

setSymbolNameCoeff

public void setSymbolNameCoeff(java.lang.String symbolName)

Sets the symbol name for the coefficients.

Parameters:

symbolName - for coefficients

setSymbolNameSubsetRes

public void setSymbolNameSubsetRes(java.lang.String symbolName)

Sets the symbol name for the subset restrictions that are set for the coefficients.

Parameters:

symbolName - for subset restrictions

setSymbolNameVariables

public void setSymbolNameVariables(java.lang.String symbolName)

Sets the symbol name ffor the variable names corresponding to the coefficients.

Parameters:

symbolName - for variable names

setTablePopup

public void setTablePopup(javax.swing.JPopupMenu newTablePopup)

Sets the popup menu for the underlying coefficients tables.

Parameters:

newTablePopup - popup component

setSymbolScope

public void setSymbolScope(Scope scope)

Sets the symbol scope, which defines which symbol table to use (local, global or upper).

Overrides:

setSymbolScope in class EqTerm

Parameters:

scope - the symbol scope

Throws:

java.lang.IllegalArgumentException - if (scope == null)