Package org.esa.snap.ui

Class ExpressionPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.esa.snap.ui.ExpressionPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ProductExpressionPane

public class ExpressionPane
extends JPanel

The expression pane is a UI component which is used to edit mathematical expressions. There are four methods which can be used to customize the UI of the expression pane: {@link #setLeftAccessory}, {@link #setRightAccessory}, {@link #setTopAccessory} and {@link #setBottomAccessory}.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Modifier and Type	Field	Description
static final String	CODE_HISTORY_PREFERENCES_PREFIX	The prefix used to store the code history in the preferences.
static final String	HELP_ID
static final String	PLACEHOLDER	The string used to represent an expression placeholder for text insertion.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructors

Constructor	Description
ExpressionPane(boolean requiresBoolExpr, Parser parser, PropertyMap preferences)	Constructs a new expression pane.

Method Summary

Modifier and Type	Method	Description
protected void	checkCode()
protected void	checkCode(String code)
void	clearCode()
org.esa.snap.ui.ExpressionPane.ActionPane	createActionPane()
protected JPanel	createDefaultAccessoryPane(Component subAssessory)
JButton	createInsertButton(String pattern)
protected JPanel	createPatternInsertionPane()
JList<String>	createPatternList()
JList<String>	createPatternList(String[] patterns)
protected JPanel	createPatternListPane(String labelText, String[] patterns)
protected void	createUI()
protected void	dispose()
String	getCode()
JTextArea	getCodeArea()
String	getLastErrorMessage()
static String	getParamTypeString(String name, Term[] args)
Parser	getParser()
PropertyMap	getPreferences()
void	insertCodePattern(String pattern)
boolean	isBooleanExpressionPreferred()
boolean	isEmptyExpressionAllowed()
void	loadCodeHistory()
void	selectAllCode()
void	setBooleanExpressionPreferred(boolean booleanExpressionPreferred)
void	setBottomAccessory(Component component)
void	setCode(String newCode)
void	setCode(String newCode, boolean recordUndo, int caretPos)
void	setEmptyExpressionAllowed(boolean allow)
void	setLeftAccessory(Component component)
void	setParser(Parser parser)
void	setPreferences(PropertyMap preferences)
void	setRightAccessory(Component component)
void	setTopAccessory(Component component)
int	showModalDialog(Window parent, String title)
void	storeCodeHistory()
void	undoLastEdit()
void	updateCodeHistory()
protected void	updateUIState()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

HELP_ID

public static final String HELP_ID

See Also:

• Constant Field Values

CODE_HISTORY_PREFERENCES_PREFIX

public static final String CODE_HISTORY_PREFERENCES_PREFIX

The prefix used to store the code history in the preferences.

See Also:

• Constant Field Values

PLACEHOLDER

public static final String PLACEHOLDER

The string used to represent an expression placeholder for text insertion.

See Also:

• Constant Field Values

Constructor Details

ExpressionPane

public ExpressionPane(boolean requiresBoolExpr,
 Parser parser,
 PropertyMap preferences)

Constructs a new expression pane.

Parameters:

requiresBoolExpr - if true the expressions are checked to return a boolean value.

parser - the parser used to check expression syntax

preferences - a property map which stores expression pane related properties such as the code history

Method Details

showModalDialog

public int showModalDialog(Window parent,
 String title)

getPreferences

public PropertyMap getPreferences()

setPreferences

public void setPreferences(PropertyMap preferences)

setEmptyExpressionAllowed

public void setEmptyExpressionAllowed(boolean allow)

isEmptyExpressionAllowed

public boolean isEmptyExpressionAllowed()

updateCodeHistory

public void updateCodeHistory()

loadCodeHistory

public void loadCodeHistory()

storeCodeHistory

public void storeCodeHistory()

dispose

protected void dispose()

setLeftAccessory

public void setLeftAccessory(Component component)

setRightAccessory

public void setRightAccessory(Component component)

setTopAccessory

public void setTopAccessory(Component component)

setBottomAccessory

public void setBottomAccessory(Component component)

getCodeArea

public JTextArea getCodeArea()

isBooleanExpressionPreferred

public boolean isBooleanExpressionPreferred()

setBooleanExpressionPreferred

public void setBooleanExpressionPreferred(boolean booleanExpressionPreferred)

getParser

public Parser getParser()

setParser

public void setParser(Parser parser)

getCode

public String getCode()

setCode

public void setCode(String newCode)

setCode

public void setCode(String newCode,
 boolean recordUndo,
 int caretPos)

clearCode

public void clearCode()

selectAllCode

public void selectAllCode()

undoLastEdit

public void undoLastEdit()

insertCodePattern

public void insertCodePattern(String pattern)

createActionPane

public org.esa.snap.ui.ExpressionPane.ActionPane createActionPane()

createInsertButton

public JButton createInsertButton(String pattern)

createPatternList

public JList<String> createPatternList()

createPatternList

public JList<String> createPatternList(String[] patterns)

createPatternListPane

protected JPanel createPatternListPane(String labelText,
 String[] patterns)

createUI

protected void createUI()

createPatternInsertionPane

protected JPanel createPatternInsertionPane()

createDefaultAccessoryPane

protected JPanel createDefaultAccessoryPane(Component subAssessory)

checkCode

protected void checkCode()

checkCode

protected void checkCode(String code)

getLastErrorMessage

public String getLastErrorMessage()

updateUIState

protected void updateUIState()

getParamTypeString

public static String getParamTypeString(String name,
 Term[] args)