jACOB 2.7 API Documentation.

de.tif.jacob.screen.event
Class IOwnDrawElementEventHandler

java.lang.Object
  extended by EventHandler
      extended by de.tif.jacob.screen.event.GuiEventHandler
          extended by de.tif.jacob.screen.event.IGroupMemberEventHandler
              extended by de.tif.jacob.screen.event.IOwnDrawElementEventHandler

public abstract class IOwnDrawElementEventHandler
extends IGroupMemberEventHandler

Abstract event handler class for own draw areas. Derived implementations of this event handler class have to be used to "hook" application-specific business logic to own draw areas.


Field Summary
static java.lang.String RCS_ID
          The internal revision control system id.
static java.lang.String RCS_REV
          The internal revision control system id in short form.
 
Constructor Summary
IOwnDrawElementEventHandler()
           
 
Method Summary
abstract  java.awt.Color getTransparentColor()
          Returns the color which should be used as transparent color for the image.
abstract  void paint(IClientContext context, java.awt.Graphics graphics, java.awt.Dimension dimension)
          This hook method will be called, if the own draw area has to be refreshed.
 
Methods inherited from class de.tif.jacob.screen.event.IGroupMemberEventHandler
onGroupStatusChanged, onHide, onShow
 
Methods inherited from class de.tif.jacob.screen.event.GuiEventHandler
alert, alert, alert
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID
The internal revision control system id.

See Also:
Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV
The internal revision control system id in short form.

See Also:
Constant Field Values
Constructor Detail

IOwnDrawElementEventHandler

public IOwnDrawElementEventHandler()
Method Detail

paint

public abstract void paint(IClientContext context,
                           java.awt.Graphics graphics,
                           java.awt.Dimension dimension)
                    throws java.lang.Exception
This hook method will be called, if the own draw area has to be refreshed. Therefore, the image within the own draw area has to be painted completely by means of this method.

Parameters:
context - The current client context
graphics - The graphics object to be used for all draw operations
dimension - The dimension of the own draw area
Throws:
java.lang.Exception

getTransparentColor

public abstract java.awt.Color getTransparentColor()
                                            throws java.lang.Exception
Returns the color which should be used as transparent color for the image.

Returns:
The transparent color for the image or null, if the image does not contain a transparent color.
Throws:
java.lang.Exception

jACOB 2.7 API Documentation.