cmu.survey.editor.gui.wizards.page
Class PageCard

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.browsecode.helpers.wizard.WizardCard
                      cmu.survey.editor.gui.wizards.page.PageCard

All Implemented Interfaces:

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

Direct Known Subclasses:

PagePropertiesCard, QuestionCard

public abstract class PageCard
extends WizardCard

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

protected boolean	isNewPage
protected DataBitStorage	objectStorage
protected Page	page
protected Survey	survey
protected UndoHandler	undoHandler
protected boolean	userAlreadyPickedQuestionType

Fields inherited from class org.browsecode.helpers.wizard.WizardCard

unknownCard

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

PageCard(DataBitStorage storage)

PageCard(DataBitStorage storage, UndoHandler undoHandler)

Method Summary

void	display() Called right before showing the card, before adding it to its parent.
void	fireNextChanged() call this if the next card has changed (which might occur at a decision junction)
protected Dialogs	getDialogs()
WizardCard	getNext() return the next card in the series or null if this is the last card return an unknownCard to indicate that the next card is not yet available, but this is not the last card the general contract with a Wizard is that this function will only be called once per instance, unless fireNextChanged is invoked.
protected boolean	getNextChanged()
protected javax.swing.JTextPane	getTextArea(java.lang.String text)
protected abstract void	initDisplayNewData() This will be called automatically on the first time that a question is displayed in a screen -- only the first time that the card is displayed with a new question.
void	initialize() this method is invoked on the first transition from the previous slide to this slide, before the component is shown (display is called afterwards) this method is *not* invoked on the return trip, nor on any repeated trips -- it is only invoked once!
protected abstract void	initializeLayout()
boolean	nextClicked() this is a vetoable event that will be called when the user clicks the next button return true to proceed to the next card; return false to force the user to remain on this slide any time-sensitive mutation of the next slide should be performed here since there is no notification on returning from the next slide, this operation should be safe to execute multiple times in succession (with possibly varying configuration settings for this card).
protected void	setChangedData(boolean shouldBeTrue)
void	setNext(PageCard card)
void	setNextToUnknown()
void	setPage(Page page, boolean isNewPage)
void	setSurvey(Survey survey)

Methods inherited from class org.browsecode.helpers.wizard.WizardCard

getHasHelp, getHelpURL, getProperty, getTitle, getWizard, helpClicked, postDisplay, previousClicked, setHelpURL, setNext, setProperty, setWizard

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

objectStorage

protected DataBitStorage objectStorage

page

protected Page page

survey

protected Survey survey

isNewPage

protected boolean isNewPage

userAlreadyPickedQuestionType

protected boolean userAlreadyPickedQuestionType

undoHandler

protected UndoHandler undoHandler

Constructor Detail

PageCard

public PageCard(DataBitStorage storage)

Parameters:

storage -

PageCard

public PageCard(DataBitStorage storage,
                UndoHandler undoHandler)

Method Detail

setChangedData

protected void setChangedData(boolean shouldBeTrue)

setPage

public void setPage(Page page,
                    boolean isNewPage)

setSurvey

public void setSurvey(Survey survey)

initialize

public void initialize()

Description copied from class: WizardCard

this method is invoked on the first transition from the previous slide to this slide, before the component is shown (display is called afterwards) this method is *not* invoked on the return trip, nor on any repeated trips -- it is only invoked once!

Overrides:

initialize in class WizardCard

getNext

public WizardCard getNext()

Description copied from class: WizardCard

return the next card in the series or null if this is the last card return an unknownCard to indicate that the next card is not yet available, but this is not the last card the general contract with a Wizard is that this function will only be called once per instance, unless fireNextChanged is invoked. therefore, no caching is required (unless of course you wish to mutate the next card based on this wizard's settings)

Overrides:

getNext in class WizardCard

setNext

public void setNext(PageCard card)

fireNextChanged

public void fireNextChanged()

Description copied from class: WizardCard

call this if the next card has changed (which might occur at a decision junction)

Overrides:

fireNextChanged in class WizardCard

getNextChanged

protected boolean getNextChanged()

setNextToUnknown

public void setNextToUnknown()

nextClicked

public boolean nextClicked()

Description copied from class: WizardCard

this is a vetoable event that will be called when the user clicks the next button return true to proceed to the next card; return false to force the user to remain on this slide any time-sensitive mutation of the next slide should be performed here since there is no notification on returning from the next slide, this operation should be safe to execute multiple times in succession (with possibly varying configuration settings for this card).

Overrides:

nextClicked in class WizardCard

display

public void display()

Description copied from class: WizardCard

Called right before showing the card, before adding it to its parent. any time-sensitive initialization should be performed here rather than in the constructor this method is invoked on every transition from the previous slide to this slide this method is *not* invoked on the return trip

Overrides:

display in class WizardCard

initializeLayout

protected abstract void initializeLayout()

initDisplayNewData

protected abstract void initDisplayNewData()

This will be called automatically on the first time that a question is displayed in a screen -- only the first time that the card is displayed with a new question.

getDialogs

protected Dialogs getDialogs()

getTextArea

protected javax.swing.JTextPane getTextArea(java.lang.String text)