WizMEName (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.uml.cognitive.critics
Class WizMEName

java.lang.Object
  org.argouml.cognitive.critics.Wizard
      org.argouml.uml.cognitive.critics.UMLWizard
          org.argouml.uml.cognitive.critics.WizMEName

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: WizOperName

public class WizMEName
extends UMLWizard
extends UMLWizard

A non-modal wizard to help the user change the name of a MModelElement to a better name.

See Also:: Serialized Form

Constructor Summary
`WizMEName()` The constructor.

Method Summary
`boolean`	`canGoNext()` Return false if the user has not edited the text and they were required to.
`void`	`doAction(int oldStep)` Take action at the completion of a step.
`protected java.lang.String`	`getInstructions()`
`javax.swing.JPanel`	`makePanel(int newStep)` Create a new panel for the given step.
`void`	`setInstructions(java.lang.String s)`
`void`	`setMustEdit(boolean b)`
`void`	`setSuggestion(java.lang.String s)`

Methods inherited from class org.argouml.uml.cognitive.critics.UMLWizard
`getModelElement, getNumSteps, getSuggestion, offerSuggestion`

Methods inherited from class org.argouml.cognitive.critics.Wizard
`back, canFinish, canGoBack, doAction, finish, getCurrentPanel, getPanel, getProgress, getStep, getToDoItem, isFinished, isStarted, next, removePanel, setToDoItem, undoAction, undoAction`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

WizMEName

public WizMEName()

The constructor.

Method Detail

setInstructions

public void setInstructions(java.lang.String s)

Parameters:: s - the instructions

setMustEdit

public void setMustEdit(boolean b)

Parameters:: b - if true, then the wizard step needs userinput, i.e. it must be edited

makePanel

public javax.swing.JPanel makePanel(int newStep)

Create a new panel for the given step.

Specified by:: makePanel in class Wizard

Parameters:: newStep - the number of the step to make a panel for.
Returns:: a new panel for the given step
See Also:: Wizard.makePanel(int)

setSuggestion

public void setSuggestion(java.lang.String s)

Overrides:: setSuggestion in class UMLWizard

Parameters:: s - set a new suggestion string

canGoNext

public boolean canGoNext()

Return false if the user has not edited the text and they were required to.

Overrides:: canGoNext in class Wizard

Returns:: true iff the "Next>" button should be enabled.
See Also:: Wizard.canGoNext()

doAction

public void doAction(int oldStep)

Description copied from class: Wizard

Take action at the completion of a step. For example, when the given step is 0, do nothing; and when the given step is 1, do the first action. Argo non-modal wizards should take action as they do along, as soon as possible, they should not wait until the final step. Also, if the user pressed "Finish" doAction may be called for steps that never constructored or displayed their panels.

Specified by:: doAction in class Wizard

Parameters:: oldStep - the given step

getInstructions

protected java.lang.String getInstructions()

Returns:: Returns the instructions.