BlueSpray - Help
© SchoonerTurtles, Inc. 2012-2015

Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About

Class STItem

Extends STContentBounded

ReturnsDefaultFunctionThrows
boolean   In(double RefX,double RefY,double Tolerance) Exception
boolean   KeyPressed(STView TheView,KeyEvent TheEvent) Exception
boolean   KeyReleased(STView TheView,KeyEvent TheEvent) Exception
boolean   MouseDragged(STView TheView,MouseEvent TheEvent) Exception
boolean   MouseMoved(STView TheView,MouseEvent TheEvent) Exception
boolean   MousePressed(STView TheView,MouseEvent TheEvent) Exception
boolean   MouseReleased(STView TheView,MouseEvent TheEvent) Exception
  Move(double DeltaX,double DeltaY) Exception
  Paint(STView TheView) Exception
  PaintBackground(STView TheView) Exception
  PaintBorder(STView TheView) Exception
  PaintContent(STView TheView) Exception
  PaintHandles(STView TheView) Exception
  PaintShadow(STView TheView) Exception
  SetStyle(STStyle.USING_STYLE NewUsingStyle,STStyle New) Exception

Object Functions


boolean In(double RefX,double RefY,double Tolerance) Exception

Determines if the specific point is in the item. Used to determine if
mouse commands should be passed to a item. Non-rectangular subclasses
should override.

Parameters:
    RefX
    RefY
    Tolerance
Returns:
Throws: Exception


boolean KeyPressed(STView TheView,KeyEvent TheEvent) Exception


boolean KeyReleased(STView TheView,KeyEvent TheEvent) Exception

Called when the key is released.

Parameters:
    TheView
    TheEvent
Returns: - true if the object used the event and does not want other objects


boolean MouseDragged(STView TheView,MouseEvent TheEvent) Exception

Called when the mouse is moved with the button still down.

Parameters:
    TheView
    TheEvent
Returns: - true if the object used the event and does not want other objects


boolean MouseMoved(STView TheView,MouseEvent TheEvent) Exception

Handles the mouse moving over the item when the button is not pressed.
The object should see if the mouse is over it and change the cursor if
needed.

Parameters:
    TheView
    TheEvent
Returns: - true if the object used the event and does not want other objects


boolean MousePressed(STView TheView,MouseEvent TheEvent) Exception

Called when the mouse is pressed in the view.

Parameters:
    TheView
    TheEvent
Returns: - true if the object used the event and does not want other objects


boolean MouseReleased(STView TheView,MouseEvent TheEvent) Exception

Called when the mouse is released.

Parameters:
    TheView
    TheEvent
Returns: - true if the object used the event and does not want other objects


Move(double DeltaX,double DeltaY) Exception

Move the item by the specified amount

Parameters:
    DeltaX
    DeltaY
Throws: Exception


Paint(STView TheView) Exception

Called to have the object draw itself into the specified view. Typically
this function is not overridden. Instead, override the other paint
functions as needed.

Parameters:
    TheView
Throws: Exception


PaintBackground(STView TheView) Exception

Called to paint a background behind the item.

Parameters:
    TheView
Throws: Exception


PaintBorder(STView TheView) Exception

Finishes painting. The border should be redrawn if the contents are clipped
so that the border sits on top of the contents

Parameters:
    TheView
Throws: Exception


PaintContent(STView TheView) Exception

Called to have the item draw any content within the item. This should
only be text within a text box or an image within an image item and the
like. Backgrounds, borders, and handles should be drawn in other functions.

Parameters:
    TheView
Throws: Exception


PaintHandles(STView TheView) Exception

Draws the current handles for the object. Handles must be drawn here so
they appear on top of the rest of the drawing.

Parameters:
    TheView
Throws: Exception


PaintShadow(STView TheView) Exception

Draw a shadow outside the clipping area

Parameters:
    TheView
Throws: Exception


SetStyle(STStyle.USING_STYLE NewUsingStyle,STStyle New) Exception

Sets the style. Override this function if you need to repaint your
item and/or its icon in the project tree or the legend.

Parameters:
    NewUsingStyle - New using flag for style. Values include: