JDeveloper SCM API

oracle.ide.scm.util
Class SCMGenericOptionsCustomizer

java.lang.Object
  |
  +--oracle.ide.scm.SCMOptionsCustomizerAdapter
        |
        +--oracle.ide.scm.util.SCMGenericOptionsCustomizer
All Implemented Interfaces:
SCMOptionsCustomizer

public class SCMGenericOptionsCustomizer
extends SCMOptionsCustomizerAdapter

Generic options customizer, for user entry of common options within the file lister dialog. Can delegate to a given options customizer for reasons of extensibility.


Field Summary
static java.lang.String KEY_FILE_COMMENT
          The key for the file comment option
 
Constructor Summary
SCMGenericOptionsCustomizer()
           
SCMGenericOptionsCustomizer(SCMOptionsCustomizer customizer)
           
 
Method Summary
 void commitOptions()
          Commits any outstanding changes that may be reflected in components to the customizer's options object.
 java.awt.Component getComponent()
          Gets the initialized comments customizer component.
protected  java.lang.String getDefaultComments(SCMFile file)
          Gets the default comments option value corresponding to a given file, for use by the customizer.
 SCMOptions getOptions()
          Gets the working options object.
 void initializeOptions(java.util.List l)
          This implementation does nothing.
 void selectionChanged(SCMFile[] before, SCMFile[] after)
          Notifies the customizer that the file selection has changed.
 
Methods inherited from class oracle.ide.scm.SCMOptionsCustomizerAdapter
validateOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY_FILE_COMMENT

public static final java.lang.String KEY_FILE_COMMENT
The key for the file comment option
Constructor Detail

SCMGenericOptionsCustomizer

public SCMGenericOptionsCustomizer()

SCMGenericOptionsCustomizer

public SCMGenericOptionsCustomizer(SCMOptionsCustomizer customizer)
Method Detail

getDefaultComments

protected java.lang.String getDefaultComments(SCMFile file)
Gets the default comments option value corresponding to a given file, for use by the customizer. Do not return a null from this method.
Parameters:
file - the file whose default comments should be retrieved.
Returns:
default comments for the file.

getComponent

public java.awt.Component getComponent()
Gets the initialized comments customizer component. Also sets up the edit veto document for when the user tries to change a hidden value.
Overrides:
getComponent in class SCMOptionsCustomizerAdapter
Returns:
the component for this customizer.

initializeOptions

public void initializeOptions(java.util.List l)
This implementation does nothing. You can override.
Overrides:
initializeOptions in class SCMOptionsCustomizerAdapter
Parameters:
l - the list of all SCMFiles in the list dialog

getOptions

public SCMOptions getOptions()
Gets the working options object.
Overrides:
getOptions in class SCMOptionsCustomizerAdapter
Returns:
the customizer's options.

selectionChanged

public void selectionChanged(SCMFile[] before,
                             SCMFile[] after)
                      throws SCMSelectionVetoException
Notifies the customizer that the file selection has changed. Updates the UI comments field accordingly, committing any edits.
Overrides:
selectionChanged in class SCMOptionsCustomizerAdapter
Parameters:
before - the previously selected files.
after - the newly selected files.

commitOptions

public void commitOptions()
Commits any outstanding changes that may be reflected in components to the customizer's options object.
Overrides:
commitOptions in class SCMOptionsCustomizerAdapter

Copyright © 2002 Oracle Corporation