JDeveloper SCM API

oracle.ide.scm
Interface SCMFileStatus

All Known Implementing Classes:
SCMFileStatusObject

public interface SCMFileStatus

Interface for represented file statuses. The status of the file is its current SCM state; a value for which there is no strictly required form imposed by the framework, but must be operable by the relevant client. Framework awareness of state will only extend to navigator overlay icon retrieval, and asking whether the status implies that the file in under source control.


Method Summary
 javax.swing.Icon getOverlayIcon()
          Requests the icon which may be used within the IDE as an overlay for file images within the navigator.
 java.lang.String getString()
          Gets a human-readable String for the status, for debugging purposes only.
 boolean isControlled()
          Asks whether the status implies that a file is currently controlled by the source control client.
 boolean isVersioned()
          Asks whether the status implies that a file is currently versioned by the source control client.
 

Method Detail

isControlled

public boolean isControlled()
Asks whether the status implies that a file is currently controlled by the source control client.
Returns:
a verdict on whether the status represents controlled files.

isVersioned

public boolean isVersioned()
Asks whether the status implies that a file is currently versioned by the source control client.
Returns:
a verdict on whether the status represents versioned files.

getOverlayIcon

public javax.swing.Icon getOverlayIcon()
Requests the icon which may be used within the IDE as an overlay for file images within the navigator. These overlays are intended to convey source control file status to the user, and must be exactly 16 by 16 pixels in dimension. It is also receommended that they contain a generous amount of transparency.
Returns:
the overlay icon corresponding to this state.

getString

public java.lang.String getString()
Gets a human-readable String for the status, for debugging purposes only.
Returns:
a string representation of the status.

Copyright © 2002 Oracle Corporation