|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jdeveloper.vcs.spi.VCSCommentsCustomizer
public class VCSCommentsCustomizer
Utility class for using comments options in an options customizer.
Field Summary | |
---|---|
static java.lang.String |
COMMENT_TEMPLATES_NAVIGABLE_LABEL |
protected static java.lang.String |
KEY_PROPERTY_DEFAULT_TEMPLATE_INDEX |
protected static java.lang.String |
KEY_PROPERTY_TEMPLATES |
static java.lang.String |
KEY_SETTING_COMMENTS |
static java.lang.String |
KEY_SETTING_REUSE_COMMENTS |
Constructor Summary | |
---|---|
VCSCommentsCustomizer() Constructor. |
|
VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer) Constructor. |
Method Summary | |
---|---|
ClientSetting |
getClientSetting() Gets the ClientSetting object from which comment template settings will be retrieved. |
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. |
VCSRecentCommentsModel |
getRecentCommentsModel() Gets the comments model to be used for making historical comments available in a completion popup. |
java.lang.String |
getTemplatesDataKey() Gets the data key used to retrieve comment templates from settings. |
protected javax.swing.text.JTextComponent |
getTextComponent() Get the text component. |
protected boolean |
isCommentTextChanged() |
boolean |
isShowTemplatesAndCommentsCombo() Asks whether the customizer will show a combobox containing templates and recently used comments. |
protected void |
layoutContainer(java.awt.Container container, java.awt.Component commentsUI, java.awt.Component delegateUI) Performs layout of the comments customizer container. |
void |
setClientSetting(ClientSetting clientSetting) Sets the ClientSetting object from which comment template settings will be retrieved. |
void |
setCommentsComponentsEnabled(boolean enabled) |
void |
setContextURLs(java.net.URL[] contextUrls) Sets the contextual URLs for the comments customizer invocation. |
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 |
setRecentCommentsModel(VCSRecentCommentsModel commentsModel) Sets the comments model to be used for making historical comments available in a completion popup. |
void |
setShowReuseCommentsOption(boolean showReuseCommentsOption) Sets whether the 'reuse comments' option is supported by this customizer. |
void |
setShowTemplatesAndCommentsCombo(boolean showTemplatesAndCommentsCombo) Sets whether the customizer will show a combobox containing templates and recently used comments. |
void |
setSuppressContextMenu(boolean suppressContextMenu) Deprecated. not replaced; setting this property has no effect. |
void |
setSuppressDefaultTemplate(boolean suppressDefaultTemplate) |
void |
setSystemTemplate(java.lang.String systemTemplate) Sets a template value that will be made available alongside other comment templates. |
void |
setTemplatesAndCommentsOrientation(int templatesAndCommentsOrientation) Sets the positional orientation of the templates and comments combobox UI. |
void |
setTemplatesDataKey(java.lang.String templatesDataKey) Sets the data key used to retrieve comment templates from settings. |
void |
setTemplatesSettingsPath(java.lang.String[] templatesSettingsPath) Sets the path to the templates page in product preferences. |
void |
setVisiblePopupRows(int popupRows) Deprecated. not replaced. This class now provides support for a combobox listing previously entered comments, which can be enabled by calling setShowTemplatesAndCommentsCombo(boolean) with true. |
protected void |
updateTemplatesAndComments() |
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 |
---|
protected static final java.lang.String KEY_PROPERTY_TEMPLATES
protected static final java.lang.String KEY_PROPERTY_DEFAULT_TEMPLATE_INDEX
public static final java.lang.String KEY_SETTING_COMMENTS
public static final java.lang.String KEY_SETTING_REUSE_COMMENTS
public static final java.lang.String COMMENT_TEMPLATES_NAVIGABLE_LABEL
Constructor Detail |
---|
public VCSCommentsCustomizer()
public VCSCommentsCustomizer(VCSOptionsCustomizer delegateCustomizer)
delegateCustomizer
- the delegate options customizer instance.Method Detail |
---|
public void setShowReuseCommentsOption(boolean showReuseCommentsOption)
showReuseCommentsOption
- a decision on whether the 'reuse comments' option should be used.public void setRecentCommentsModel(VCSRecentCommentsModel commentsModel)
commentsModel
- the comments model object.public VCSRecentCommentsModel getRecentCommentsModel()
public void setShowTemplatesAndCommentsCombo(boolean showTemplatesAndCommentsCombo)
showTemplatesAndCommentsCombo
- a decision on whether templates and previous comments should be shown.public boolean isShowTemplatesAndCommentsCombo()
true
if templates and previous comments will be shown.public void setTemplatesAndCommentsOrientation(int templatesAndCommentsOrientation)
templatesAndCommentsOrientation
- the orientation value, this can be SwingConstants.SOUTH
or SwingConstants.NORTH_EAST
.public void setClientSetting(ClientSetting clientSetting)
ClientSetting
object from which comment template settings will be retrieved. This is used in conjunction with the value established by setTemplatesDataKey(java.lang.String)
.clientSetting
- the client settings object.public ClientSetting getClientSetting()
ClientSetting
object from which comment template settings will be retrieved.public void setTemplatesDataKey(java.lang.String templatesDataKey)
setClientSetting(oracle.ide.config.ClientSetting)
.templatesDataKey
- the data key.public java.lang.String getTemplatesDataKey()
public void setSystemTemplate(java.lang.String systemTemplate)
systemTemplate
- the system template value.public void setTemplatesSettingsPath(java.lang.String[] templatesSettingsPath)
templatesSettingsPath
- the qualified path.
@Deprecated
public void setSuppressContextMenu(boolean suppressContextMenu)
suppressContextMenu
- a decision on whether the context menu should be suppressed.public void setDefaultVisibleRows(int rows)
rows
- the number of rows to display.
@Deprecated
public void setVisiblePopupRows(int popupRows)
setShowTemplatesAndCommentsCombo(boolean)
with true.popupRows
- the number of completion popup rows to display.public void setFlatLook(boolean isFlat)
isFlat
- true if the component should be painted in a flat stylepublic final void setContextURLs(java.net.URL[] contextUrls)
contextUrls
- the contextual URLs.public final void setSuppressDefaultTemplate(boolean suppressDefaultTemplate)
public java.awt.Component getComponent()
VCSOptionsCustomizer
getComponent
in interface VCSOptionsCustomizer
public java.awt.Component getInitialFocusComponent()
VCSOptionsCustomizer
getInitialFocusComponent
in interface VCSOptionsCustomizer
public void setOptions(java.util.Map<?,?> options)
VCSOptionsCustomizer
setOptions
in interface VCSOptionsCustomizer
options
- the map of options values.public java.util.Map<?,?> getOptions()
VCSOptionsCustomizer
getOptions
in interface VCSOptionsCustomizer
public void validateOptions() throws VCSException
VCSOptionsCustomizer
validateOptions
in interface VCSOptionsCustomizer
VCSException
- if an option states is invalid.public void setCommentsComponentsEnabled(boolean enabled)
protected final void updateTemplatesAndComments()
protected void layoutContainer(java.awt.Container container, java.awt.Component commentsUI, java.awt.Component delegateUI)
container
- the container to lay out.commentsUI
- the user interface component for comments entry.delegateUI
- the user interface component for delegate options entry.protected javax.swing.text.JTextComponent getTextComponent()
protected final boolean isCommentTextChanged()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |