org.installguru.installer
Class TextInputPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.installguru.installer.InstallTaskPanel
                                |
                                +--org.installguru.installer.TextInputPanel

All Implemented Interfaces:

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

public class TextInputPanel

extends InstallTaskPanel

This is a GUI task which is used to take input from the user to perform some custom install operations. You need to write a plugin class to acompany the installer to customise this screen. Read documentation for more info.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

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

TextInputPanel()
Creates new TextInputPanel

Method Summary

void	addItem(java.lang.String key, java.lang.String label, java.lang.String text) Adds a new text input field.
void	doCancel(java.util.Properties properties) This method is called by the installer when the install operation is cancelled by the user.
boolean	doNext(java.util.Properties properties) This method is called by the installer when it is moved to the next task.
java.lang.String	getMessage() Gets the message to be displayed.
void	init(java.util.Properties properties) This method is called by the installer whenever this task is initialized.
boolean	isOSSupported() Returns true if this task is supported in the operating system currently it is running on.
void	setMessage(java.lang.String message) Sets the message string to be displayed to the user.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInputPanel

public TextInputPanel()

Creates new TextInputPanel

Method Detail

doCancel

public void doCancel(java.util.Properties properties)

Description copied from interface: InstallTask

This method is called by the installer when the install operation is cancelled by the user.

Following copied from interface: org.installguru.installer.InstallTask

Parameters:

props - installer properties.

doNext

public boolean doNext(java.util.Properties properties)

Description copied from interface: InstallTask

This method is called by the installer when it is moved to the next task.

Following copied from interface: org.installguru.installer.InstallTask

Parameters:

props - installer properties.

Returns:

true to allow to move to next task. Otherwise it stays on this task.

Throws:

InstallException. -

isOSSupported

public boolean isOSSupported()

Description copied from interface: InstallTask

Returns true if this task is supported in the operating system currently it is running on. The OS independent tasks will always return true.

init

public void init(java.util.Properties properties)

Description copied from interface: InstallTask

This method is called by the installer whenever this task is initialized.

Following copied from interface: org.installguru.installer.InstallTask

Parameters:

props - installer properties.

Throws:

InstallException. -

getMessage

public java.lang.String getMessage()

Gets the message to be displayed.

Returns:

message string.

setMessage

public void setMessage(java.lang.String message)

Sets the message string to be displayed to the user.

Parameters:

message - New value of property message.

addItem

public void addItem(java.lang.String key,
                    java.lang.String label,
                    java.lang.String text)

Adds a new text input field.

Parameters:

key - the key by which the input value is stored in the installer properties.

label - label for the text field.

text - initial value of the text field.