com.ibm.dse.tools.workbench.gui
Class TemplateEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.ibm.dse.tools.workbench.gui.TemplateEditor

public class TemplateEditor
extends javax.swing.JDialog

This class implements a template editor. The user can modify an existing template or add a new one.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
TemplateEditor()
          Creates a non-modal TemplateEditor dialog without a title and without a specified Frame owner.
TemplateEditor(java.awt.Dialog owner)
          Creates a non-modal TemplateEditor dialog without a title with the specifed Dialog as its owner.
TemplateEditor(java.awt.Dialog owner, boolean modal)
          Creates a modal or non-modal TemplateEditor dialog without a title and with the specified owner dialog.
TemplateEditor(java.awt.Dialog owner, java.lang.String title)
          Creates a non-modal TemplateEditor dialog with the specified title and with the specified owner dialog.
TemplateEditor(java.awt.Dialog owner, java.lang.String title, boolean modal)
          Creates a modal or non-modal TemplateEditor dialog with the specified title and the specified owner frame.
TemplateEditor(java.awt.Frame owner)
          Creates a non-modal TemplateEditor dialog without a title with the specifed Frame as its owner.
TemplateEditor(java.awt.Frame owner, boolean modal)
          Creates a modal or non-modal TemplateEditor dialog without a title and with the specified owner frame.
TemplateEditor(java.awt.Frame owner, java.lang.String title)
          Creates a non-modal TemplateEditor dialog with the specified title and with the specified owner frame.
TemplateEditor(java.awt.Frame owner, java.lang.String title, boolean modal)
          Creates a modal or non-modal TemplateEditor dialog with the specified title and the specified owner frame.
 
Method Summary
 boolean accepted()
          This method returns if the edition has been accepted or not
 java.lang.String getProtectedTemplateLocation()
          Returns the template location without password information
 java.lang.String getTemplateDescription()
          Returns the template description
 java.lang.String getUnprotectedTemplateLocation()
          Returns the template location with user information
 void setTemplateDescription(java.lang.String description)
          Sets the template description
 void setTemplateLocation(java.lang.String location)
          Sets the template location
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TemplateEditor

public TemplateEditor()
Creates a non-modal TemplateEditor dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the Dialog.

TemplateEditor

public TemplateEditor(java.awt.Dialog owner)
Creates a non-modal TemplateEditor dialog without a title with the specifed Dialog as its owner.
Parameters:
owner - the Dialog from which the dialog is displayed
owner - java.awt.Dialog

TemplateEditor

public TemplateEditor(java.awt.Dialog owner,
                      java.lang.String title)
Creates a non-modal TemplateEditor dialog with the specified title and with the specified owner dialog.
Parameters:
owner - the Dialog from which the dialog is displayed
title - the String to display in the dialog's title bar

TemplateEditor

public TemplateEditor(java.awt.Dialog owner,
                      java.lang.String title,
                      boolean modal)
Creates a modal or non-modal TemplateEditor dialog with the specified title and the specified owner frame.
Parameters:
owner - the dialog from which the dialog is displayed
title - the String to display in the dialog's title bar
modal - true for a modal dialog, false for one that allows others windows to be active at the same time

TemplateEditor

public TemplateEditor(java.awt.Dialog owner,
                      boolean modal)
Creates a modal or non-modal TemplateEditor dialog without a title and with the specified owner dialog.
Parameters:
owner - the Dialog from which the dialog is displayed
modal - true for a modal dialog, false for one that allows others windows to be active at the same time

TemplateEditor

public TemplateEditor(java.awt.Frame owner)
Creates a non-modal TemplateEditor dialog without a title with the specifed Frame as its owner.
Parameters:
owner - the Frame from which the dialog is displayed

TemplateEditor

public TemplateEditor(java.awt.Frame owner,
                      java.lang.String title)
Creates a non-modal TemplateEditor dialog with the specified title and with the specified owner frame.
Parameters:
owner - the Frame from which the dialog is displayed
title - the String to display in the dialog's title bar

TemplateEditor

public TemplateEditor(java.awt.Frame owner,
                      java.lang.String title,
                      boolean modal)
Creates a modal or non-modal TemplateEditor dialog with the specified title and the specified owner frame.
Parameters:
owner - the frame from which the dialog is displayed
title - the String to display in the dialog's title bar
modal - true for a modal dialog, false for one that allows others windows to be active at the same time

TemplateEditor

public TemplateEditor(java.awt.Frame owner,
                      boolean modal)
Creates a modal or non-modal TemplateEditor dialog without a title and with the specified owner frame.
Parameters:
owner - the Frame from which the dialog is displayed
modal - true for a modal dialog, false for one that allows others windows to be active at the same time
Method Detail

accepted

public boolean accepted()
This method returns if the edition has been accepted or not
Returns:
boolean

getProtectedTemplateLocation

public java.lang.String getProtectedTemplateLocation()
Returns the template location without password information
Returns:
java.lang.String

getTemplateDescription

public java.lang.String getTemplateDescription()
Returns the template description
Returns:
java.lang.String

getUnprotectedTemplateLocation

public java.lang.String getUnprotectedTemplateLocation()
Returns the template location with user information
Returns:
java.lang.String

setTemplateDescription

public void setTemplateDescription(java.lang.String description)
Sets the template description
Parameters:
description - java.lang.String

setTemplateLocation

public void setTemplateLocation(java.lang.String location)
Sets the template location
Parameters:
location - java.lang.String