com.adventnet.nms.rta.fw.client
Class ProbePanel

com.adventnet.nms.rta.fw.client.ProbePanel

public class ProbePanel

This will acts as the RTA UI's Probe List Holder class. This is responsible for notifying the RTA UI implementation about the changes/modification done on the Probe panel, i.e if any attribute is added/deleted/modified using the buttons provided in this component, the same will be notified to the ProbePanelActions lisetener. Also this will notify the RTA Data model component about the selection/deselection/updation of the nodes in the tree.

Field Summary

javax.swing.JButton	addButton
javax.swing.JButton	copyButton
javax.swing.JButton	cutButton
boolean	enableCutCopyPaste
javax.swing.JPopupMenu	folderPopup
javax.swing.JPopupMenu	leafPopup
javax.swing.JButton	pasteButton
javax.swing.JMenuItem	pMenu

Constructor Summary

ProbePanel()

ProbePanel(java.applet.Applet applet)

Method Summary

void	addProbePanelListener(ProbePanelListener moduleUI) This method will be used to (Right hand side) register moduleUI which implemented the ProbePanelListenere interface with the ProbePanel for getting the notification about the selection/deselection/modification.
boolean	applyToServer() This method is called on the actionPerformed event of the button Apply on the Right hand side moduleUI.
void	destroy() This is the ParameterChangeListener interface method implementation.
void	dispose() This method is called by Right hand side moduleUI in the implementation of dispose method of ApplyToServerInterface
void	enableControllPanel(boolean enable) This method is to enable/disable some of the UI components based on the selection/operation.
void	fireProbeSelectionChanged() This will be called whenever the change of probe selection happens.
java.lang.String	getParameter(java.lang.String input) This will be created by the Bean Builder, as this is the builder project.
void	init() This will be created by the Bean Builder, as this is the builder project.
void	initialize() This method is used to intialize the ProbePanel
void	initVariables() This will be created by the Bean Builder, as this is the builder project.
boolean	isNeedsToBeApplied() This method is used by (Right hand side) moduleUI in the imeplentation of method isModified of ApplyToServerInterface
void	parameterChanged(com.adventnet.apiutils.ParameterObject paramObj) This is the ParameterChangeListener interface method implementation.
void	registerForActions(ProbePanelActions notify) This method will be used by (Right hand side) moduleUI to set the adpater for receiveing notifications of actions in the ProbePanel
void	removeControlPanel() This method is to disable the UI component, which has the probes list in it.
void	setConstraints(int x, int y, int width, int height, double wtX, double wtY, int anchor, int fill, java.awt.Insets inset, int padX, int padY) This will be created by the Bean Builder, as this is the builder project.
void	setControllPanelDisplay(int type) This method is to enable/disable some of the UI components based on the selection/operation.
void	setDefaultSelection() This method is to set the default selection in the probelist tree.
void	setEnableCutCopyPasteMenu(boolean enable)
void	setModuleResourceBundle(com.adventnet.nms.rta.fw.client.BuilderResourceBundle moduleResourceBundle) This method will be used to set the Resourcebundle of the custom module, so that the 'values' of the i18 keys can be obtained from that bundle.
void	setParameterObject(com.adventnet.apiutils.ParameterObject paramObj) This is the ParameterChangeListener interface method implementation.
void	setProbeDataModel(AbstractRTADataModel moduleData) This method will be used to set the DataModel impelemted for (Right hand side) moduleUI
void	setProperties(java.util.Properties props) This will be created by the Bean Builder, as this is the builder project.
void	setTitle(java.lang.String title) This method is used to set the title displayed in the ProbePanel Component
void	setUpConnections() This will be created by the Bean Builder, as this is the builder project.
void	setUpGUI(java.awt.Container container) This will be created by the Bean Builder, as this is the builder project.
void	setUpProperties() This will be created by the Bean Builder, as this is the builder project.
void	setVisibleCustomizeView(boolean flag) This is to anable/disable the 'CustomizeView' button.
int	showConfirmation(java.lang.String title, java.lang.String message, java.lang.String details, int optionType) This is to show the confirmation dialog.
void	showDialog(RTAException exp) This is to show the status/error dialog.
void	showDialog(java.lang.String title, java.lang.String message, java.lang.String[] values, java.lang.String details, int optionType) This is to show the status/error dialog.
void	showDialog(java.lang.String title, java.lang.String message, java.lang.String details, int optionType) This is to show the status/error dialog.
void	showStatus(java.lang.String message) This will be created by the Bean Builder, as this is the builder project.
void	showStatus(java.lang.String message, java.lang.Exception ex) This will be created by the Bean Builder, as this is the builder project.
void	start() This will be created by the Bean Builder, as this is the builder project.
void	stop() This will be created by the Bean Builder, as this is the builder project.
void	updateCustomViewIcon() This method is to update the icon associated with the probe name in the probepanel tree, this is applicable only for the MultiObjectModel.

Field Detail

addButton

public javax.swing.JButton addButton

cutButton

public javax.swing.JButton cutButton

copyButton

public javax.swing.JButton copyButton

pasteButton

public javax.swing.JButton pasteButton

leafPopup

public javax.swing.JPopupMenu leafPopup

folderPopup

public javax.swing.JPopupMenu folderPopup

pMenu

public javax.swing.JMenuItem pMenu

enableCutCopyPaste

public boolean enableCutCopyPaste

Constructor Detail

ProbePanel

public ProbePanel()

ProbePanel

public ProbePanel(java.applet.Applet applet)

Method Detail

stop

public void stop()

This will be created by the Bean Builder, as this is the builder project. This is for internal usage.

setEnableCutCopyPasteMenu

public void setEnableCutCopyPasteMenu(boolean enable)

start

public void start()

This will be created by the Bean Builder, as this is the builder project. This is for internal usage.

init

public void init()

This will be created by the Bean Builder, as this is the builder project. In this method, the necessary intializations can be done. Normally the UI components will be created and shown from this method. This is for internal usage.

getParameter

public java.lang.String getParameter(java.lang.String input)

This will be created by the Bean Builder, as this is the builder project. This method will return the value of the parameter, passed as as argument to this method. This is for internal usage.

setUpProperties

public void setUpProperties()

This will be created by the Bean Builder, as this is the builder project. In this method the properties like tooltip, size, etc will be set to the UI components. This is for internal usage.

initVariables

public void initVariables()

This will be created by the Bean Builder, as this is the builder project. In this method, all the components used in this UI, will be instantiated. This is for internal usage.

setUpGUI

public void setUpGUI(java.awt.Container container)

This will be created by the Bean Builder, as this is the builder project. In this method, all the components in the UI will be instantiated positioned, i.e the layout properties will be set for the UI components. This is for internal usage.

setUpConnections

public void setUpConnections()

This will be created by the Bean Builder, as this is the builder project. In this method, appropriate listeners will be added for the UI components based on the need. This is for internal usage.

showStatus

public void showStatus(java.lang.String message)

This will be created by the Bean Builder, as this is the builder project. In this method, error/status message will be printed if any error occurs. This is for internal usage.

showStatus

public void showStatus(java.lang.String message,
                       java.lang.Exception ex)

This will be created by the Bean Builder, as this is the builder project. In this method, error/status message will be printed if any error occurs. This is for internal usage.

setProperties

public void setProperties(java.util.Properties props)

This will be created by the Bean Builder, as this is the builder project. In this method, the new property value can be added or the existing property value can be modified/deleted, this property can be used later based on the requirement. This is for internal usage.

parameterChanged

public void parameterChanged(com.adventnet.apiutils.ParameterObject paramObj)

This is the ParameterChangeListener interface method implementation. By default the bean builder project implements ParameterChangeListener interface. This method will be called whenever any of the property value is changed, i.e if the setProperties method adds/modifies/deletes any entries in the existing property values. This is for internal usage.

destroy

public void destroy()

This is the ParameterChangeListener interface method implementation. By default the bean builder project implements ParameterChangeListener interface. This method will be called whenever any of the property value is changed, i.e if the setProperties method adds/modifies/deletes any entries in the existing property values. This is for internal usage.

setParameterObject

public void setParameterObject(com.adventnet.apiutils.ParameterObject paramObj)

This is the ParameterChangeListener interface method implementation. By default the bean builder project implements ParameterChangeListener interface. The parameter object, which actually stores the property values will be changed in the method. This is for internal usage.

setConstraints

public void setConstraints(int x,
                           int y,
                           int width,
                           int height,
                           double wtX,
                           double wtY,
                           int anchor,
                           int fill,
                           java.awt.Insets inset,
                           int padX,
                           int padY)

This will be created by the Bean Builder, as this is the builder project. This method is used to set the constraints, for the components, which uses GridBagLayout as its layout class. This is for internal usage.

addProbePanelListener

public void addProbePanelListener(ProbePanelListener moduleUI)

This method will be used to (Right hand side) register moduleUI which implemented the ProbePanelListenere interface with the ProbePanel for getting the notification about the selection/deselection/modification.

Parameters:

moduleUI - the DataPanel UI component

setProbeDataModel

public void setProbeDataModel(AbstractRTADataModel moduleData)

This method will be used to set the DataModel impelemted for (Right hand side) moduleUI

Parameters:

dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of \"DefaultSingleObjectModel\" or \"DefultMultiObjectModel\" class.

registerForActions

public void registerForActions(ProbePanelActions notify)

This method will be used by (Right hand side) moduleUI to set the adpater for receiveing notifications of actions in the ProbePanel

Parameters:

notify - ProbePanelActions instance, using which the pre/post probe modification notification can be notified.

initialize

public void initialize()

This method is used to intialize the ProbePanel

isNeedsToBeApplied

public boolean isNeedsToBeApplied()

This method is used by (Right hand side) moduleUI in the imeplentation of method isModified of ApplyToServerInterface

applyToServer

public boolean applyToServer()

This method is called on the actionPerformed event of the button Apply on the Right hand side moduleUI.

fireProbeSelectionChanged

public void fireProbeSelectionChanged()

This will be called whenever the change of probe selection happens. This is for internal use.

showDialog

public void showDialog(java.lang.String title,
                       java.lang.String message,
                       java.lang.String[] values,
                       java.lang.String details,
                       int optionType)

This is to show the status/error dialog. This is for internal use.

showDialog

public void showDialog(java.lang.String title,
                       java.lang.String message,
                       java.lang.String details,
                       int optionType)

This is to show the status/error dialog. This is for internal use.

showDialog

public void showDialog(RTAException exp)

This is to show the status/error dialog. This is for internal use.

showConfirmation

public int showConfirmation(java.lang.String title,
                            java.lang.String message,
                            java.lang.String details,
                            int optionType)

This is to show the confirmation dialog. This is for internal use.

enableControllPanel

public void enableControllPanel(boolean enable)

This method is to enable/disable some of the UI components based on the selection/operation. This is for internal use.

removeControlPanel

public void removeControlPanel()

This method is to disable the UI component, which has the probes list in it. This is for internal use.

setDefaultSelection

public void setDefaultSelection()

This method is to set the default selection in the probelist tree. This is for internal use.

setModuleResourceBundle

public void setModuleResourceBundle(com.adventnet.nms.rta.fw.client.BuilderResourceBundle moduleResourceBundle)

This method will be used to set the Resourcebundle of the custom module, so that the 'values' of the i18 keys can be obtained from that bundle.

Parameters:

moduleResourceBundle - Resource bundle of the custom module

setControllPanelDisplay

public void setControllPanelDisplay(int type)

This method is to enable/disable some of the UI components based on the selection/operation. This is for internal use.

updateCustomViewIcon

public void updateCustomViewIcon()

This method is to update the icon associated with the probe name in the probepanel tree, this is applicable only for the MultiObjectModel. This is for internal use.

setVisibleCustomizeView

public void setVisibleCustomizeView(boolean flag)

This is to anable/disable the 'CustomizeView' button. This is for internal use.

dispose

public void dispose()

This method is called by Right hand side moduleUI in the implementation of dispose method of ApplyToServerInterface

setTitle

public void setTitle(java.lang.String title)

This method is used to set the title displayed in the ProbePanel Component

Parameters:

title - title string of the Probe Panel.