chemaxon.alchemist
Class AlchemistPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  chemaxon.alchemist.AlchemistPage

All Implemented Interfaces:

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

Direct Known Subclasses:

AlchemistGlassPage, FileListHandlerPanel, ProgressPanel

public abstract class AlchemistPage
extends javax.swing.JPanel

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String

PROPERTY_KEY_MOVE_NEXT Property key for notifying controller to move next page

Fields inherited from class javax.swing.JComponent

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

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

AlchemistPage()

Method Summary

abstract void	enterPage(AlchemistState state) This method is called when this page becomes the active.
java.awt.Component	getGlassPane() Gets the rootpane's glasspane component
javax.swing.event.SwingPropertyChangeSupport	getNotifier() This method returns the notifier of this page
void	hideProgressBar() This method replaces progress bar with bottom text
boolean	isBottomTextVisible() Returns if bottom messagebar is visible
abstract boolean	isCorrect() Returns if the current state of the form is correct.
boolean	isPageEnabled()
boolean	isTopTextVisible() Returns if top messagebar is visible
abstract void	leavePage(AlchemistState state) This method is called before this bage becomes inactive.
void	performLeavePage() This method is called before leavePage, and can interrupt the leave process.
void	setBottomText(java.lang.String bottomText) Sets the footer text of the panel
void	setBottomTextVisible(boolean visible) Shows or hides the footer text
void	setGlassPane(java.awt.Component component) Sets glasspane of the rootpane
void	setPageEnabled(boolean pageEnabled) Sets the page state.
void	setTopText(java.lang.String title, java.lang.String text) Sets the titlebar text of the panel
void	setTopTextVisible(boolean visible) Shows or hides the titlebar
void	showProgressBar(java.lang.String progressLabelText) This method replaces bottom text with a progress bar NOTE: this method resets progress bar value
void	showProgressBar(java.lang.String progressLabelText, javax.swing.Action cancelAction) This method replaces bottom text with a cancelable progress bar NOTE: this method resets progress bar value
void	updateProgressBar(float percent) This method updates progress bar to the given percent NOTE: calling showProgressBar(String progressLabelText) resets value
void	updateProgressBar(int percent) This method updates progress bar to the given percent NOTE: calling showProgressBar(String progressLabelText) resets value

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_KEY_MOVE_NEXT

public static final java.lang.String PROPERTY_KEY_MOVE_NEXT

Property key for notifying controller to move next page

See Also:

Constant Field Values

Constructor Detail

AlchemistPage

public AlchemistPage()

Method Detail

isCorrect

public abstract boolean isCorrect()

Returns if the current state of the form is correct.

Returns:

boolean

setTopText

public void setTopText(java.lang.String title,
                       java.lang.String text)

Sets the titlebar text of the panel

Parameters:

title - is the bold, single line title

text - is the multi line comment

setTopTextVisible

public void setTopTextVisible(boolean visible)

Shows or hides the titlebar

Parameters:

visible -

setBottomText

public void setBottomText(java.lang.String bottomText)

Sets the footer text of the panel

Parameters:

bottomText - is the single line text

setBottomTextVisible

public void setBottomTextVisible(boolean visible)

Shows or hides the footer text

Parameters:

visible -

isBottomTextVisible

public boolean isBottomTextVisible()

Returns if bottom messagebar is visible

Returns:

boolean, the visibility of bottom message bar

isTopTextVisible

public boolean isTopTextVisible()

Returns if top messagebar is visible

Returns:

boolean, the visibility of top message bar

isPageEnabled

public boolean isPageEnabled()

setPageEnabled

public void setPageEnabled(boolean pageEnabled)

Sets the page state.

Parameters:

pageEnabled - is the state

enterPage

public abstract void enterPage(AlchemistState state)

This method is called when this page becomes the active. Initializes the page depending on parameters contained in state object.

Parameters:

state - is the state object holding workflow data

leavePage

public abstract void leavePage(AlchemistState state)

This method is called before this bage becomes inactive. Saves the page state into the state object

Parameters:

state - is the state object holding workflow data

performLeavePage

public void performLeavePage()

This method is called before leavePage, and can interrupt the leave process. Usually time consuming jobs should be done here

getNotifier

public javax.swing.event.SwingPropertyChangeSupport getNotifier()

This method returns the notifier of this page

Returns:

the notifier

showProgressBar

public void showProgressBar(java.lang.String progressLabelText)

This method replaces bottom text with a progress bar NOTE: this method resets progress bar value

Parameters:

progressLabelText - will be the text shown next to progress bar

showProgressBar

public void showProgressBar(java.lang.String progressLabelText,
                            javax.swing.Action cancelAction)

This method replaces bottom text with a cancelable progress bar NOTE: this method resets progress bar value

Parameters:

progressLabelText - will be the txt showb next to progress bar

cancelAction - is the action will be invoked when cancel button pressed

hideProgressBar

public void hideProgressBar()

This method replaces progress bar with bottom text

updateProgressBar

public void updateProgressBar(int percent)

This method updates progress bar to the given percent NOTE: calling showProgressBar(String progressLabelText) resets value

Parameters:

percent - is the new percentage

See Also:

showProgressBar(String)

updateProgressBar

public void updateProgressBar(float percent)

This method updates progress bar to the given percent NOTE: calling showProgressBar(String progressLabelText) resets value

Parameters:

percent - is the new percentage

See Also:

showProgressBar(String)

setGlassPane

public void setGlassPane(java.awt.Component component)

Sets glasspane of the rootpane

Parameters:

component - the glasspane object

getGlassPane

public java.awt.Component getGlassPane()

Gets the rootpane's glasspane component

Returns:

Component