Extension SDK 10.1.2


oracle.jdeveloper.vcs.spi
Class VCSCommentsCustomizer

java.lang.Object
  extended byoracle.jdeveloper.vcs.spi.VCSCommentsCustomizer

All Implemented Interfaces:
VCSOptionsCustomizer

public class VCSCommentsCustomizer
extends java.lang.Object
implements VCSOptionsCustomizer

Utility class for using comments options in an options customizer.

Since:
9.0.5

Field Summary
static java.lang.String KEY_SETTING_COMMENTS
static java.lang.String KEY_SETTING_REUSE_COMMENTS

Constructor Summary
VCSCommentsCustomizer()
Constructor
VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer)
Constructor.
VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer, boolean showReuseCommentsOption)
Constructor.

Method Summary
java.awt.Component getComponent()
Gets the component of the options cusomizer instance.
java.awt.Component getInitialFocusComponent()
Get the component to focus initially when the customizer is displayed.
java.util.Map getOptions()
Gets options from the customizer, based on internal component states.
protected javax.swing.text.JTextComponent getTextComponent()
Get the text component.
protected void layoutContainer(java.awt.Container container, java.awt.Component commentsUI, java.awt.Component delegateUI)
Performs layout of the comments customizer container.
void setDefaultVisibleRows(int rows)
Override the default number of visible rows.
void setFlatLook(boolean isFlat)
Set whether this component has a flat look.
void setOptions(java.util.Map options)
Sets options on the customizer, updating internal component states.
void validateOptions()
Validates internal component states ahead of committing options.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_SETTING_COMMENTS

public static final java.lang.String KEY_SETTING_COMMENTS
See Also:
Constant Field Values

KEY_SETTING_REUSE_COMMENTS

public static final java.lang.String KEY_SETTING_REUSE_COMMENTS
See Also:
Constant Field Values

Constructor Detail

VCSCommentsCustomizer

public VCSCommentsCustomizer()
Constructor

VCSCommentsCustomizer

public VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer)
Constructor.
Parameters:
delegateCustomizer - the delegate options customizer instance.

VCSCommentsCustomizer

public VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer,
                             boolean showReuseCommentsOption)
Constructor.
Parameters:
delegateCustomizer - the delegate options customizer instance.
showReuseCommentsOption - a decision on whether the 'reuse comments' option should be used.

Method Detail

setDefaultVisibleRows

public void setDefaultVisibleRows(int rows)
Override the default number of visible rows.
Parameters:
rows - the number of rows to display.

setFlatLook

public void setFlatLook(boolean isFlat)
Set whether this component has a flat look.
Parameters:
isFlat - true if the component should be painted in a flat style

getTextComponent

protected javax.swing.text.JTextComponent getTextComponent()
Get the text component.
Returns:
the text component.

getComponent

public java.awt.Component getComponent()
Description copied from interface: VCSOptionsCustomizer
Gets the component of the options cusomizer instance.
Specified by:
getComponent in interface VCSOptionsCustomizer
Returns:
the customzier's component.

getInitialFocusComponent

public java.awt.Component getInitialFocusComponent()
Description copied from interface: VCSOptionsCustomizer
Get the component to focus initially when the customizer is displayed.
Specified by:
getInitialFocusComponent in interface VCSOptionsCustomizer
Returns:
a component to focus. (null-capable)

setOptions

public void setOptions(java.util.Map options)
Description copied from interface: VCSOptionsCustomizer
Sets options on the customizer, updating internal component states.
Specified by:
setOptions in interface VCSOptionsCustomizer
Parameters:
options - the map of options values.

getOptions

public java.util.Map getOptions()
Description copied from interface: VCSOptionsCustomizer
Gets options from the customizer, based on internal component states.
Specified by:
getOptions in interface VCSOptionsCustomizer
Returns:
a map of options values.

validateOptions

public void validateOptions()
                     throws VCSException
Description copied from interface: VCSOptionsCustomizer
Validates internal component states ahead of committing options.
Specified by:
validateOptions in interface VCSOptionsCustomizer
Throws:
VCSException - if an option states is invalid.

layoutContainer

protected void layoutContainer(java.awt.Container container,
                               java.awt.Component commentsUI,
                               java.awt.Component delegateUI)
Performs layout of the comments customizer container.
Parameters:
container - the container to lay out.
commentsUI - the user interface component for comments entry.
delegateUI - the user interface component for delegate options entry.

Extension SDK


Copyright © 1997, 2004, Oracle. All rights reserved.