JDeveloper SCM API

oracle.ide.scm.op
Class SCMToggleOperation

java.lang.Object
  |
  +--oracle.ide.scm.op.SCMToggleOperation
All Implemented Interfaces:
SCMOperation

public abstract class SCMToggleOperation
extends java.lang.Object
implements SCMOperation

Client adapter for toggle style operations. Deferred methods are :


Constructor Summary
SCMToggleOperation()
           
 
Method Summary
abstract  boolean getToggleState()
          Gets the toggle-state of the operation for updating visible controls.
abstract  boolean isEnabled(boolean control)
          Asks whether this operation can be enabled depending on general client state.
 boolean isEnabled(boolean control, SCMContext context)
          Asks whether this operation can be enabled depending on general client state.
 boolean isNodeRemovalCheckEnabled()
          Flag indicating whether the operation runtime should check for removed files after this operation and update the navigator.
abstract  void toggle(boolean on)
          Notification of a change in toggle-state, resulting from user interaction, for specialized property toggle operations.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.ide.scm.SCMOperation
getControlItem
 

Constructor Detail

SCMToggleOperation

public SCMToggleOperation()
Method Detail

isNodeRemovalCheckEnabled

public boolean isNodeRemovalCheckEnabled()
Flag indicating whether the operation runtime should check for removed files after this operation and update the navigator. If your operation may remove files on the filesystem, you will want to return true from this method. Otherwise, returning false will result in better performance.

Specified by:
isNodeRemovalCheckEnabled in interface SCMOperation
Returns:
true if the operation runtime should check for removed files after running this operation.

getToggleState

public abstract boolean getToggleState()
Gets the toggle-state of the operation for updating visible controls.

Returns:
a value for the current toggle state.

toggle

public abstract void toggle(boolean on)
Notification of a change in toggle-state, resulting from user interaction, for specialized property toggle operations.

Parameters:
on - the operation's new toggle state.

isEnabled

public boolean isEnabled(boolean control,
                         SCMContext context)
Description copied from interface: SCMOperation
Asks whether this operation can be enabled depending on general client state. An indication of whether source control is currently operative is given to assist the decision.

Specified by:
isEnabled in interface SCMOperation
Parameters:
control - source control enabled state indicator.
context - the IDE's current context.
Returns:
a verdict on whether the operation is permitted.

isEnabled

public abstract boolean isEnabled(boolean control)
Asks whether this operation can be enabled depending on general client state. An indication of whether source control is currently operative is given to assist the decision.

Parameters:
control - source control enabled state indicator.
Returns:
a verdict on whether the operation is permitted.

Copyright © 2002 Oracle Corporation

 

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