org.youscope.addon.measurement.pages

Class DescriptionPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.youscope.addon.measurement.MeasurementAddonUIPage<MeasurementConfiguration>

org.youscope.addon.measurement.pages.DescriptionPage

All Implemented Interfaces:

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

public class DescriptionPage
extends MeasurementAddonUIPage<MeasurementConfiguration>

A page describing the measurement type, eventually showing some figure, e.g. a flow diagram or similar.

Author:

Moritz Lang

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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.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 and Description
DescriptionPage(java.lang.String header, java.lang.String text) Constructor.
DescriptionPage(java.lang.String header, java.lang.String text, javax.swing.Icon descriptiveImage, java.lang.String iconLegend) Constructor.
DescriptionPage(java.lang.String pageName, java.lang.String header, java.lang.String text) Constructor.
DescriptionPage(java.lang.String pageName, java.lang.String header, java.lang.String text, javax.swing.Icon descriptiveImage, java.lang.String iconLegend) Constructor.

Method Summary

Modifier and Type	Method and Description
void	createUI(YouScopeFrame frame) Called to create the UI elements during the loading process.
java.lang.String	getPageName() Returns a short name/description what the page does.
void	loadData(MeasurementConfiguration configuration) Loads the configuration data.
boolean	saveData(MeasurementConfiguration configuration) Saves the configuration data.
void	setToDefault(MeasurementConfiguration configuration) Sets the values corresponding to this page to their default values.

Methods inherited from class org.youscope.addon.measurement.MeasurementAddonUIPage

addSizeChangeListener, fireSizeChanged, removeSizeChangeListener

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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Constructor Detail

DescriptionPage

public DescriptionPage(java.lang.String pageName,
                       java.lang.String header,
                       java.lang.String text,
                       javax.swing.Icon descriptiveImage,
                       java.lang.String iconLegend)

Constructor.

Parameters:

pageName - Name of the page. If set to null, defaults to "Description".

header - Title of the measurement description. If set to null, defaults to "Description:".

text - Measurement description.

descriptiveImage - An image to illustrate the measurement. If null, no image is displayed.

iconLegend - Text displayed directly below the image. If null, no legend will be added. Parameter is ignored if descriptiveImage is null.

DescriptionPage

public DescriptionPage(java.lang.String header,
                       java.lang.String text)

Constructor.

Parameters:

header - Title of the measurement description. If set to null, defaults to "Description:".

text - Measurement description.

DescriptionPage

public DescriptionPage(java.lang.String header,
                       java.lang.String text,
                       javax.swing.Icon descriptiveImage,
                       java.lang.String iconLegend)

Constructor.

Parameters:

header - Title of the measurement description. If set to null, defaults to "Description:".

text - Measurement description.

descriptiveImage - An image to illustrate the measurement. If null, no image is displayed.

iconLegend - Text displayed directly below the image. If null, no legend will be added. Parameter is ignored if descriptiveImage is null.

DescriptionPage

public DescriptionPage(java.lang.String pageName,
                       java.lang.String header,
                       java.lang.String text)

Constructor.

Parameters:

pageName - Name of the page. If set to null, defaults to "Description".

header - Title of the measurement description. If set to null, defaults to "Description:".

text - Measurement description.

Method Detail

loadData

public void loadData(MeasurementConfiguration configuration)

Description copied from class: MeasurementAddonUIPage

Loads the configuration data.

Specified by:

loadData in class MeasurementAddonUIPage<MeasurementConfiguration>

saveData

public boolean saveData(MeasurementConfiguration configuration)

Description copied from class: MeasurementAddonUIPage

Saves the configuration data. If the configuration is invalid, a message should be displayed to the user.

Specified by:

saveData in class MeasurementAddonUIPage<MeasurementConfiguration>

Returns:

Returns true if data is valid, false otherwise.

setToDefault

public void setToDefault(MeasurementConfiguration configuration)

Description copied from class: MeasurementAddonUIPage

Sets the values corresponding to this page to their default values.

Specified by:

setToDefault in class MeasurementAddonUIPage<MeasurementConfiguration>

Parameters:

configuration - The configuration to set to default values.

getPageName

public java.lang.String getPageName()

Description copied from class: MeasurementAddonUIPage

Returns a short name/description what the page does.

Specified by:

getPageName in class MeasurementAddonUIPage<MeasurementConfiguration>

Returns:

Name of page.

createUI

public void createUI(YouScopeFrame frame)

Description copied from class: MeasurementAddonUIPage

Called to create the UI elements during the loading process.

Specified by:

createUI in class MeasurementAddonUIPage<MeasurementConfiguration>

Parameters:

frame - The frame in which this panel is initialized. Needed since child frames might be opened.