| java.lang.Object
 org.eclipse.ui.internal.decorators.DecorationScheduler
| DecorationScheduler | | public class DecorationScheduler (Code) | | The DecorationScheduler is the class that handles the decoration of elements
using a background thread.
|
| Method Summary | |
| void | clearResults()
An external update request has been made. | | public Image | decorateWithOverlays(Image image, Object element, Object adaptedElement, IDecorationContext context)
Decorate the supplied image, element and its adapted value.
Image
Parameters:
image -
Parameters:
element -
Parameters:
adaptedElement - The adapted value of element. | | public String | decorateWithText(String text, Object element, Object adaptedElement, IDecorationContext context)
Decorate the text for the receiver. | | synchronized void | decorated()
Execute a label update using the pending decorations. | | public Color | getBackgroundColor(Object element, Object adaptedElement)
Return the background Color for element. | | public Font | getFont(Object element, Object adaptedElement)
Return the font for element. | | public Color | getForegroundColor(Object element, Object adaptedElement)
Return the foreground Color for element. | | boolean | hasPendingUpdates()
Return whether or not there are any updates pending. | | protected void | internalPutResult(Object element, IDecorationContext context, DecorationResult result)
| | public boolean | isDecorationReady(Object element, IDecorationContext context)
Return whether or not there is a decoration for this element ready. | | void | listenerRemoved(ILabelProviderListener listener)
A listener has been removed. | | synchronized DecorationReference | nextElement()
Get the next resource to be decorated. | | public boolean | processingUpdates()
| | synchronized void | queueForDecoration(Object element, Object adaptedElement, boolean forceUpdate, String undecoratedText, IDecorationContext context)
Queue the element and its adapted value if it has not been already.
Parameters:
element -
Parameters:
adaptedElement - The adapted value of element. | | synchronized void | shutdown()
Shutdown the decoration. | | protected boolean | updatesPending()
|
| EMPTY_LISTENER_LIST | | final static ILabelProviderListener[] EMPTY_LISTENER_LIST(Code) | | |
| NEEDS_INIT | | final static int NEEDS_INIT(Code) | | |
| UPDATE_DELAY | | final static int UPDATE_DELAY(Code) | | Amount of time to delay the update notification when max reached.
|
| awaitingDecorationValues | | Map awaitingDecorationValues(Code) | | |
| decorationJob | | Job decorationJob(Code) | | |
| shutdown | | boolean shutdown(Code) | | |
| DecorationScheduler | | DecorationScheduler(DecoratorManager manager)(Code) | | Return a new instance of the receiver configured for the supplied
DecoratorManager.
Parameters:
manager - |
| clearResults | | void clearResults()(Code) | | An external update request has been made. Clear the results as they are
likely obsolete now.
|
| decorateWithOverlays | | public Image decorateWithOverlays(Image image, Object element, Object adaptedElement, IDecorationContext context)(Code) | | Decorate the supplied image, element and its adapted value.
Image
Parameters:
image -
Parameters:
element -
Parameters:
adaptedElement - The adapted value of element. May be null.
Parameters:
context - the decoration context |
| decorateWithText | | public String decorateWithText(String text, Object element, Object adaptedElement, IDecorationContext context)(Code) | | Decorate the text for the receiver. If it has already been done then
return the result, otherwise queue it for decoration.
String
Parameters:
text -
Parameters:
element -
Parameters:
adaptedElement - The adapted value of element. May be null.
Parameters:
context - the decoration context |
| decorated | | synchronized void decorated()(Code) | | Execute a label update using the pending decorations.
|
| getBackgroundColor | | public Color getBackgroundColor(Object element, Object adaptedElement)(Code) | | Return the background Color for element. If there is no result cue for
decoration and return null, otherwise return the value in the result.
Parameters:
element - The Object to be decorated
Parameters:
adaptedElement - Color or null if there is no value or if it is hasnot been decorated yet. |
| getFont | | public Font getFont(Object element, Object adaptedElement)(Code) | | Return the font for element. If there is no result cue for decoration and
return null, otherwise return the value in the result.
Parameters:
element - The Object to be decorated
Parameters:
adaptedElement - Font or null if there is no value or if it is hasnot been decorated yet. |
| getForegroundColor | | public Color getForegroundColor(Object element, Object adaptedElement)(Code) | | Return the foreground Color for element. If there is no result cue for
decoration and return null, otherwise return the value in the result.
Parameters:
element - The Object to be decorated
Parameters:
adaptedElement - Color or null if there is no value or if it is hasnot been decorated yet. |
| hasPendingUpdates | | boolean hasPendingUpdates()(Code) | | Return whether or not there are any updates pending.
|
| isDecorationReady | | public boolean isDecorationReady(Object element, IDecorationContext context)(Code) | | Return whether or not there is a decoration for this element ready.
Parameters:
element -
Parameters:
context - The decoration context boolean true if the element is ready. |
| listenerRemoved | | void listenerRemoved(ILabelProviderListener listener)(Code) | | A listener has been removed. If we are updating then skip it.
Parameters:
listener - |
| processingUpdates | | public boolean processingUpdates()(Code) | | Return whether or not any updates are being processed/
boolean |
| queueForDecoration | | synchronized void queueForDecoration(Object element, Object adaptedElement, boolean forceUpdate, String undecoratedText, IDecorationContext context)(Code) | | Queue the element and its adapted value if it has not been already.
Parameters:
element -
Parameters:
adaptedElement - The adapted value of element. May be null.
Parameters:
forceUpdate - If true then a labelProviderChanged is fired whetherdecoration occurred or not.
Parameters:
undecoratedText - The original text for the element if it is known.
Parameters:
context - The decoration context |
| shutdown | | synchronized void shutdown()(Code) | | Shutdown the decoration.
|
| updatesPending | | protected boolean updatesPending()(Code) | | Return whether or not we are waiting on updated
true if there are updates waiting to be served |
|
|