oracle.jdeveloper.vcs.changelist
Class ChangeListCommentsCustomizer

java.lang.Object
  oracle.jdeveloper.vcs.spi.VCSCommentsCustomizer
      oracle.jdeveloper.vcs.changelist.ChangeListCommentsCustomizer

All Implemented Interfaces:

VCSOptionsCustomizer

public class ChangeListCommentsCustomizer
extends VCSCommentsCustomizer

Comments customizer that installs specific behaviors for the change list. Clients should use this in preference to directly using VCSCommentsCustomizer for the following features: - "Flat" look by default - Fewer lines by default - Support for main menu items on the Edit menu (Cut, Copy, Paste, Delete, Select All) - Support for "persistent" options that remain set for the lifetime of the customizer. Unlike the superclass, a new Map is not created each time you call getOptions(), so you can safely change the options map by calling getOptions().put( key, value ).

Field Summary

static java.lang.String

KEY_SETTING_COMMENTS

Fields inherited from class oracle.jdeveloper.vcs.spi.VCSCommentsCustomizer

COMMENT_TEMPLATES_NAVIGABLE_LABEL, KEY_PROPERTY_DEFAULT_TEMPLATE_INDEX, KEY_PROPERTY_TEMPLATES, KEY_SETTING_REUSE_COMMENTS

Constructor Summary

ChangeListCommentsCustomizer()

Method Summary

void	addMouseListener(java.awt.event.MouseListener ml)
void	clear()
java.lang.String	getCommentText()
java.lang.String	getDefaultTemplate()
java.util.Map	getOptions() Gets options from the customizer, based on internal component states.
void	removeMouseListener(java.awt.event.MouseListener ml)
void	setClientSetting(ClientSetting clientSetting) Sets the ClientSetting object from which comment template settings will be retrieved.
void	setCommentText(java.lang.String text)
void	setOptions(java.util.Map optionsMap) Sets options on the customizer, updating internal component states.
void	setRecentCommentsModel(VCSRecentCommentsModel commentsModel) Sets the comments model to be used for making historical comments available in a completion popup.
void	setTemplatesDataKey(java.lang.String templatesDataKey) Sets the data key used to retrieve comment templates from settings.

Methods inherited from class oracle.jdeveloper.vcs.spi.VCSCommentsCustomizer

getClientSetting, getComponent, getInitialFocusComponent, getRecentCommentsModel, getTemplatesDataKey, getTextComponent, isCommentTextChanged, isShowTemplatesAndCommentsCombo, layoutContainer, setCommentsComponentsEnabled, setContextURLs, setDefaultVisibleRows, setFlatLook, setShowReuseCommentsOption, setShowTemplatesAndCommentsCombo, setSuppressContextMenu, setSuppressDefaultTemplate, setSystemTemplate, setTemplatesAndCommentsOrientation, setTemplatesSettingsPath, setVisiblePopupRows, updateTemplatesAndComments, validateOptions

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

Constructor Detail

ChangeListCommentsCustomizer

public ChangeListCommentsCustomizer()

Method Detail

setRecentCommentsModel

public void setRecentCommentsModel(VCSRecentCommentsModel commentsModel)

Description copied from class: VCSCommentsCustomizer

Sets the comments model to be used for making historical comments available in a completion popup.

Overrides:

setRecentCommentsModel in class VCSCommentsCustomizer

Parameters:

commentsModel - the comments model object.

setClientSetting

public void setClientSetting(ClientSetting clientSetting)

Description copied from class: VCSCommentsCustomizer

Sets the ClientSetting object from which comment template settings will be retrieved. This is used in conjunction with the value established by VCSCommentsCustomizer.setTemplatesDataKey(java.lang.String).

Overrides:

setClientSetting in class VCSCommentsCustomizer

Parameters:

clientSetting - the client settings object.

setTemplatesDataKey

public void setTemplatesDataKey(java.lang.String templatesDataKey)

Description copied from class: VCSCommentsCustomizer

Sets the data key used to retrieve comment templates from settings. This is used in conjunction with the value established by VCSCommentsCustomizer.setClientSetting(oracle.ide.config.ClientSetting).

Overrides:

setTemplatesDataKey in class VCSCommentsCustomizer

Parameters:

templatesDataKey - the data key.

getDefaultTemplate

public final java.lang.String getDefaultTemplate()

addMouseListener

public void addMouseListener(java.awt.event.MouseListener ml)

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener ml)

setOptions

public void setOptions(java.util.Map optionsMap)

Description copied from interface: VCSOptionsCustomizer

Sets options on the customizer, updating internal component states.

Specified by:

setOptions in interface VCSOptionsCustomizer

Overrides:

setOptions in class VCSCommentsCustomizer

Parameters:

optionsMap - 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

Overrides:

getOptions in class VCSCommentsCustomizer

Returns:

a map of options values.

clear

public void clear()

setCommentText

public void setCommentText(java.lang.String text)

getCommentText

public java.lang.String getCommentText()