Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.uda
Interface ISystemUDTypeEditPaneTypesSelector

All Known Implementing Classes:
SystemUDSimpleTypesListEditor, UDTypesEditorFiles

public interface ISystemUDTypeEditPaneTypesSelector


Field Summary
static String copyright
           
 
Method Summary
 void addModifyListener(ModifyListener listener)
          Allow the edit pane (or any consumer) to be informed as changes are made to the list.
 void clearTypes()
          Clear the types.
 Control getControl()
          Return the primary input-capable control.
 String getTypes()
          Retrieve the types as a single string.
 void removeModifyListener(ModifyListener listener)
          Allow the edit pane (or any consumer) to stop listening as changes are made to the list.
 void setDomain(int domain)
          Set domain.
 void setEditable(boolean editable, String vendor)
          We want to disable editing of IBM or vendor-supplied types, so when one of these is selected, this method is called to enter non-editable mode.
 void setEnabled(boolean enable)
          Enable or disable the input-capability of the constituent controls
 void setMessageLine(ISystemMessageLine msgLine)
          Set the msg line in case this composite widget needs to issue an error msg
 void setTypes(String types)
          Initialize the types.
 SystemMessage validate()
          Validate input, and return the error message if an error is found.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

setDomain

public void setDomain(int domain)
Set domain. The edit pane may possibly appear differently, depending on the domain. When the domain changes (either in "new" or "edit" mode) this method is called.


setMessageLine

public void setMessageLine(ISystemMessageLine msgLine)
Set the msg line in case this composite widget needs to issue an error msg


setTypes

public void setTypes(String types)
Initialize the types. These are stored as a single string using a subsystem-decidable delimiter character. This is called when entering "edit" mode.


clearTypes

public void clearTypes()
Clear the types. That is, make sure none are selected. This is called when entering "new" mode.


getTypes

public String getTypes()
Retrieve the types as a single string. The delimiter used is up to the implementor, as long as it knows how to parse and assemble the types list as a single string.


addModifyListener

public void addModifyListener(ModifyListener listener)
Allow the edit pane (or any consumer) to be informed as changes are made to the list. When events are fired, the consumer will call getTypes() to get the new list.


removeModifyListener

public void removeModifyListener(ModifyListener listener)
Allow the edit pane (or any consumer) to stop listening as changes are made to the list.


validate

public SystemMessage validate()
Validate input, and return the error message if an error is found. This is called by the consumer upon receipt of a modify event, to show any error messages and to know if there are errors pending or not.


getControl

public Control getControl()
Return the primary input-capable control. Used to set focus, among other things.


setEnabled

public void setEnabled(boolean enable)
Enable or disable the input-capability of the constituent controls


setEditable

public void setEditable(boolean editable,
                        String vendor)
We want to disable editing of IBM or vendor-supplied types, so when one of these is selected, this method is called to enter non-editable mode.

Parameters:
editable - Whether to disable editing of this type or not
vendor - When disabling, it contains the name of the vendor for substitution purposes

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.