JDeveloper SCM API

oracle.ide.scm
Interface SCMPropertyCustomizer

All Known Implementing Classes:
SCMPropertyCustomizerAdapter

public interface SCMPropertyCustomizer

Property-based class for getting and setting client property values on configuration components. Intended to allow SCM clients to customize an options screen relevant to source control setup, whilst remaining under the control of the IDE.


Method Summary
 java.awt.Component getComponent()
          Gets the user interface component for this customizer, to handle user edits on the client's property set.
 java.util.Map getProperties()
          Gets the properties Map for this customizer, reflecting the UI state.
 void setProperties(java.util.Map props)
          Sets the properties for all components of the panel from the given table, thus updating the UI.
 void validateProperties()
          Validates the current properties held in the customizer panel.
 

Method Detail

getComponent

public java.awt.Component getComponent()
Gets the user interface component for this customizer, to handle user edits on the client's property set.
Returns:
a component that contains user interface controls which will be placed on the dialog this customizer is for.

setProperties

public void setProperties(java.util.Map props)
Sets the properties for all components of the panel from the given table, thus updating the UI.
Parameters:
props - a keyed table for all property values.

validateProperties

public void validateProperties()
                        throws SCMException
Validates the current properties held in the customizer panel.
Throws:
SCMException - if a property value is found to be invalid.

getProperties

public java.util.Map getProperties()
Gets the properties Map for this customizer, reflecting the UI state. This is a table storing named values, to be recognised and applied by the SCM client.
Returns:
the current properties table for the customizer.

Copyright © 2002 Oracle Corporation