Pane (JPAZ2 1.1.1 API)

java.lang.Object
- sk.upjs.jpaz2.Pane

All Implemented Interfaces:

PaneObject

Direct Known Subclasses:

Scene, WinPane
```
public class Pane
extends Object
implements PaneObject
```
The Pane represents a rectangle pane with graphical content and ability to host (provide home) for pane objects like other panes, turtles, etc. It provides the methods for basic handling of mouse and keyboard events.

Field Summary

Fields
Modifier and Type Field and Description

protected String referenceIdentification
Reference identification of the instance.

Fields
Modifier and Type	Field and Description
`protected String`	`referenceIdentification` Reference identification of the instance.

Constructor Summary

Constructors
Constructor and Description
`Pane()` Constructs a pane with predefined size.
`Pane(int width, int height)` Constructs a pane at position [0, 0] with center in its top-left corner.
`Pane(int x, int y, int width, int height)` Constructs a pane at a given position.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(PaneObject o)` Adds the new pane object (Pane, Turtle, etc.) on the pane.
`void`	`bringToBack(PaneObject o)` Moves a pane object to back of all other pane objects.
`void`	`bringToBackOf(PaneObject o, PaneObject location)` Moves a pane object to back of another pane object.
`void`	`bringToFront(PaneObject o)` Moves a pane object to front of all other pane objects.
`void`	`bringToFrontOf(PaneObject o, PaneObject location)` Moves a pane object to front of another pane object.
`boolean`	`canClick(int x, int y, boolean inParentCoordinates)` Returns whether a point at given location is clickable, i.e., a hand mouse cursor should be shown over this point.
`void`	`clear()` Cleans the graphical content of the pane.
`boolean`	`containsPoint(int x, int y)` Returns whether the pane contains a point at given coordinates.
`void`	`draw(Shape shape, Stroke stroke, Color color, Paint paint)` Draws the shape to the pane.
`void`	`fill(Shape shape, Stroke stroke, Color color, Paint paint)` Fills the shape to the pane.
`Color`	`getBackgroundColor()` Gets the pane's background color.
`Color`	`getBorderColor()` Gets the current border color.
`int`	`getBorderWidth()` Gets the current border with (in pixels).
`Point2D`	`getCenter()` Gets the coordinates of the pane's center.
`int`	`getHeight()` Gets the current height of this pane.
`long`	`getKeyRepeatPeriod()` Returns the period in which key pressed events are generated for key codes that are hold.
`long`	`getKeyRepeatPeriod(int keyCode)` Returns the period in which key pressed events are generated for given key code when it is hold.
`int`	`getObjectCount()` Gets the number of children objects currently living in this pane.
`Pane`	`getPane()` Gets the current parent pane of this pane.
`Pane`	`getPane(int index)` Gets the pane associated with the specified index.
`int`	`getPaneCount()` Gets the number of children panes currently living in this pane.
`PaneObject`	`getPaneObject(int index)` Gets the pane object associated with the specified index.
`PaneObject[]`	`getPaneObjects()` Gets an array of all children object currently living in this pane.
`Pane[]`	`getPanes()` Gets an array of children panes currently living in this pane.
`Point2D`	`getPosition()` Returns the position of this pane.
`double`	`getRotation()` Gets the rotation angle of this pane in degrees.
`long`	`getTickPeriod()` Gets the time period (in milliseconds) in which the onTick method is executed.
`double`	`getTransparency()` Gets the current transparency of the pane.
`Turtle`	`getTurtle(int index)` Gets the turtle associated with the specified index.
`int`	`getTurtleCount()` Gets the number of turtles currently living in this pane.
`Turtle[]`	`getTurtles()` Gets an array of turtles currently living in this pane.
`int`	`getWidth()` Gets the current width of this pane.
`double`	`getX()` Gets the x-coordinate of this pane relative to the parent pane.
`double`	`getXCenter()` Gets the x-coordinate of the center of this pane.
`double`	`getY()` Gets the y-coordinate of this pane relative to the parent pane.
`double`	`getYCenter()` Gets the y-coordinate of the center of this pane.
`void`	`invalidate()` Marks that the content of the pane is no longer valid.
`boolean`	`isAntialiased()` Gets whether the drawing actions are antialiased.
`boolean`	`isMouseTransparent()` Returns whether the pane is transparent for mouse events.
`boolean`	`isTransparentBackground()` Returns whether drawing the pane's background is disabled.
`boolean`	`isTurtleCentering()` Returns whether turtles are centered when added to this pane.
`protected boolean`	`onCanClick(int x, int y)` Called when querying whether a point at given location can be clicked.
`protected void`	`onKeyPressed(KeyEvent e)` Called on key pressed event.
`protected void`	`onKeyReleased(KeyEvent e)` Called on key released event.
`protected void`	`onKeyTyped(KeyEvent e)` Called on key typed event.
`protected void`	`onMouseClicked(int x, int y, MouseEvent detail)` Called on mouse clicked event.
`protected void`	`onMouseDragged(int x, int y, MouseEvent detail)` Called on mouse dragged event.
`protected void`	`onMouseMoved(int x, int y, MouseEvent detail)` Called on mouse moved event.
`protected void`	`onMousePressed(int x, int y, MouseEvent detail)` Called on mouse pressed event.
`protected void`	`onMouseReleased(int x, int y, MouseEvent detail)` Called on mouse released event.
`protected void`	`onTick()` Called periodically by the pane.
`void`	`paintToPaneGraphics(Graphics2D g)` Paints the pane to a graphics at position relative to parent's coordinate system.
`void`	`remove(PaneObject o)` Removes a pane object from the pane.
`void`	`resize(int newWidth, int newHeight)` Resizes the pane.
`boolean`	`savePicture(String filename)` Stores picture of the pane to an image file.
`void`	`setAntialiased(boolean antialiased)` Sets whether the drawing actions are antialiased.
`void`	`setBackgroundColor(Color backgroundColor)` Sets the pane's background color.
`void`	`setBorderColor(Color borderColor)` Sets the new border color.
`void`	`setBorderWidth(int borderWidth)` Sets new border with.
`void`	`setCenter(double xCenter, double yCenter)` Changes the location of center of this pane.
`void`	`setCenter(Point2D center)` Sets the center of this pane.
`void`	`setHeight(int height)` Sets new height of this pane.
`void`	`setKeyRepeatPeriod(int keyCode, long keyRepeatPeriod)` Sets the period in which key pressed events are generated for given key code when it is hold.
`void`	`setKeyRepeatPeriod(long keyRepeatPeriod)` Sets the period in which key pressed events are generated for key codes that are hold.
`void`	`setMouseTransparent(boolean mouseTransparent)` Sets transparency of the pane for mouse events.
`void`	`setPane(Pane newParentPane)` Sets the parent pane of this pane.
`void`	`setPosition(double x, double y)` Changes the position of the pane.
`void`	`setPosition(Point2D position)` Changes the location of the pane.
`void`	`setRotation(double rotation)` Sets the rotation angle of this pane.
`void`	`setTickPeriod(long tickPeriod)` Sets the time period (in milliseconds) in which the onTick method is executed.
`void`	`setTransparency(double transparency)` Sets the pane's transparency.
`void`	`setTransparentBackground(boolean transparentBackground)` Sets whether the pane's background is drawn, i.e., whether pane's background is transparent.
`void`	`setTurtleCentering(boolean turtleCentering)` Sets whether turtles are centered when added to this pane.
`void`	`setWidth(int width)` Sets new width of this pane.
`void`	`setX(double x)` Sets the new x-coordinate of this pane.
`void`	`setXCenter(double xCenter)` Sets the x-coordinate of the center of this pane.
`void`	`setY(double y)` Sets the new y-coordinate of this pane.
`void`	`setYCenter(double yCenter)` Sets the y-coordinate of the center of this pane.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - referenceIdentification
```
protected final String referenceIdentification
```
    Reference identification of the instance.
- Constructor Detail
  - Pane
```
public Pane()
```
    Constructs a pane with predefined size.
  - Pane
```
public Pane(int width,
            int height)
```
    Constructs a pane at position [0, 0] with center in its top-left corner.
    
    Parameters:
    
    width - the width of the pane
    
    height - the height of the pane
  - Pane
```
public Pane(int x,
            int y,
            int width,
            int height)
```
    Constructs a pane at a given position. Center of the pane is set to its top-left corner.
    
    Parameters:
    
    x - the x-coordinate of the top-left corner of the pane
    
    y - the y-coordinate of the top-left corner of the pane
    
    width - the width of the pane
    
    height - the height of the pane
- Method Detail
  - getWidth
```
public int getWidth()
```
    Gets the current width of this pane.
    
    Returns:
    
    the with of this pane.
  - setWidth
```
public void setWidth(int width)
```
    Sets new width of this pane. The change of the width resizes this pane.
    
    Parameters:
    
    width - the desired width of the pane.
  - getHeight
```
public int getHeight()
```
    Gets the current height of this pane.
    
    Returns:
    
    the height of this pane.
  - setHeight
```
public void setHeight(int height)
```
    Sets new height of this pane. The change of the height resizes this pane.
    
    Parameters:
    
    height - the desired height of the pane.
  - getX
```
public double getX()
```
    Gets the x-coordinate of this pane relative to the parent pane. The position of the pane is determined by the position of its center.
    
    Returns:
    
    the x-coordinate of the pane.
  - setX
```
public void setX(double x)
```
    Sets the new x-coordinate of this pane. The position of the pane is determined by the position of its center.
    
    Parameters:
    
    x - the desired x-coordinate of the pane.
  - getY
```
public double getY()
```
    Gets the y-coordinate of this pane relative to the parent pane. The position of the pane is determined by the position of its center.
    
    Returns:
    
    the y-coordinate of the pane.
  - setY
```
public void setY(double y)
```
    Sets the new y-coordinate of this pane. The position of the pane is determined by the position of its center.
    
    Parameters:
    
    y - the desired y-coordinate of the pane.
  - getXCenter
```
public double getXCenter()
```
    Gets the x-coordinate of the center of this pane. The location of center is specified relative to coordinates of this pane.
    
    Returns:
    
    the x-coordinate of the pane's center.
  - setXCenter
```
public void setXCenter(double xCenter)
```
    Sets the x-coordinate of the center of this pane. The location of the center is specified with respect to coordinate system of this pane.
    
    Parameters:
    
    xCenter - the desired x-coordinate of the pane's center.
  - getYCenter
```
public double getYCenter()
```
    Gets the y-coordinate of the center of this pane. The location of center is specified relative to coordinates of this pane.
    
    Returns:
    
    the y-coordinate of the pane's center.
  - setYCenter
```
public void setYCenter(double yCenter)
```
    Sets the y-coordinate of the center of this pane. The location of the center is specified with respect to coordinate system of this pane.
    
    Parameters:
    
    yCenter - the desired y-coordinate of the pane's center.
  - setCenter
```
public void setCenter(Point2D center)
```
    Sets the center of this pane. The location of the center is specified relative to coordinate system of this pane.
    
    Parameters:
    
    center - the desired coordinates of the pane's center.
  - getCenter
```
public Point2D getCenter()
```
    Gets the coordinates of the pane's center. The location of center is specified relative to coordinates of this pane.
    
    Returns:
    
    the coordinates of the pane's center.
  - getRotation
```
public double getRotation()
```
    Gets the rotation angle of this pane in degrees.
    
    Returns:
    
    the rotation angle in degrees.
  - setRotation
```
public void setRotation(double rotation)
```
    Sets the rotation angle of this pane. The pane is rotated with respect to position of its center.
    
    Parameters:
    
    rotation - the desired rotation angle in degrees.
  - resize
```
public void resize(int newWidth,
                   int newHeight)
```
    Resizes the pane.
    
    Parameters:
    
    newWidth - desired width of the pane.
    
    newHeight - desired height of the pane.
  - setPosition
```
public void setPosition(double x,
                        double y)
```
    Changes the position of the pane. The new position of the pane is determined by coordinates of its center relative to the coordinate system of the parent pane.
    
    Parameters:
    
    x - the desired x-coordinate.
    
    y - the desired y-coordinate.
  - setPosition
```
public void setPosition(Point2D position)
```
    Changes the location of the pane. The new position of the pane is determined by coordinates of its center relative to the coordinate system of the parent pane.
    
    Parameters:
    
    position - the desired position of this pane.
  - getPosition
```
public Point2D getPosition()
```
    Returns the position of this pane. The position of the pane is determined by coordinates of its center relative to the coordinate system of the parent pane.
    
    Returns:
    
    the position of this pane.
  - setCenter
```
public void setCenter(double xCenter,
                      double yCenter)
```
    Changes the location of center of this pane. The location of center is specified relative to coordinate system of this pane. Change of the center does not move the pane, only position of the pane is recomputed.
    
    Parameters:
    
    xCenter - the desired x-coordinate of the center.
    
    yCenter - the desired y-coordinate of the center.
  - containsPoint
```
public boolean containsPoint(int x,
                             int y)
```
    Returns whether the pane contains a point at given coordinates. The coordinates are expressed with respect to parent pane's coordinate system.
    
    Parameters:
    
    x - the x-coordinate of the point.
    
    y - the y-coordinate of the point.
    
    Returns:
    
    true, if the point is covered (contained) by the pane, false otherwise.
  - getBorderWidth
```
public int getBorderWidth()
```
    Gets the current border with (in pixels). The border is drawn over the pane content, i.e., it is an internal pane border.
    
    Returns:
    
    the border width.
  - setBorderWidth
```
public void setBorderWidth(int borderWidth)
```
    Sets new border with. The border is drawn over the pane content, i.e., it is an internal pane border.
    
    Parameters:
    
    borderWidth - the desired border with in pixels.
  - getBorderColor
```
public Color getBorderColor()
```
    Gets the current border color. The border is drawn over the pane content, i.e., it is an internal pane border.
    
    Returns:
    
    the border color.
  - setBorderColor
```
public void setBorderColor(Color borderColor)
```
    Sets the new border color. The border is drawn over the pane content, i.e., it is an internal pane border.
    
    Parameters:
    
    borderColor - the desired color of the border. If it is set to null, no border is drawn.
  - getTransparency
```
public double getTransparency()
```
    Gets the current transparency of the pane. The transparency is a real number between 0 (no transparency) and 1 (fully transparent).
    
    Returns:
    
    the transparency.
  - setTransparency
```
public void setTransparency(double transparency)
```
    Sets the pane's transparency. The transparency is a real number between 0 (no transparency) and 1 (fully transparent).
    
    Parameters:
    
    transparency - the desired pane's transparency. If it is a number smaller than 0, the value 0 is set. If it is a number greater than 1, the value 1 is set.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Gets the pane's background color.
    
    Returns:
    
    the background color.
  - setBackgroundColor
```
public void setBackgroundColor(Color backgroundColor)
```
    Sets the pane's background color.
    
    Parameters:
    
    backgroundColor - the desired pane's background color. If set to null, the pane's background is transparent.
  - isTransparentBackground
```
public boolean isTransparentBackground()
```
    Returns whether drawing the pane's background is disabled.
    
    Returns:
    
    true, if the drawing the pane's background is disabled, i.e., the pane's background is transparent; false otherwise.
  - setTransparentBackground
```
public void setTransparentBackground(boolean transparentBackground)
```
    Sets whether the pane's background is drawn, i.e., whether pane's background is transparent.
    
    Parameters:
    
    transparentBackground - true for transparent (not drawn) background
  - isAntialiased
```
public boolean isAntialiased()
```
    Gets whether the drawing actions are antialiased.
    
    Returns:
    
    true if the antialiasing is enabled, false otherwise.
  - setAntialiased
```
public void setAntialiased(boolean antialiased)
```
    Sets whether the drawing actions are antialiased.
    
    Parameters:
    
    antialiased - true for drawing with antialiasing, false for drawing without anitialiasing.
  - paintToPaneGraphics
```
public void paintToPaneGraphics(Graphics2D g)
```
    Paints the pane to a graphics at position relative to parent's coordinate system.
    
    Specified by:
    
    paintToPaneGraphics in interface PaneObject
    
    Parameters:
    
    g - the graphics where the content is drawn.
  - invalidate
```
public void invalidate()
```
    Marks that the content of the pane is no longer valid.
  - clear
```
public void clear()
```
    Cleans the graphical content of the pane.
  - getPane
```
public Pane getPane()
```
    Gets the current parent pane of this pane. If this pane don't have a parent, null is returned.
    
    Specified by:
    
    getPane in interface PaneObject
    
    Returns:
    
    the pane in which this pane is contained.
  - setPane
```
public void setPane(Pane newParentPane)
```
    Sets the parent pane of this pane. First, the pane is removed from its current parent pane. Later, it is added to the new parent pane.
    
    Specified by:
    
    setPane in interface PaneObject
    
    Parameters:
    
    newParentPane - the new parent pane
  - add
```
public void add(PaneObject o)
```
    Adds the new pane object (Pane, Turtle, etc.) on the pane.
    
    Parameters:
    
    o - the object adding to the pane. If null, nothing is done.
  - isTurtleCentering
```
public boolean isTurtleCentering()
```
    Returns whether turtles are centered when added to this pane.
    
    Returns:
    
    true, if the turtles are centered, false otherwise.
  - setTurtleCentering
```
public void setTurtleCentering(boolean turtleCentering)
```
    Sets whether turtles are centered when added to this pane.
    
    Parameters:
    
    turtleCentering - true, to enabled centering, false to disable.
  - remove
```
public void remove(PaneObject o)
```
    Removes a pane object from the pane. If the object is not living in this pane, nothing is done.
    
    Parameters:
    
    o - the removing pane object
  - bringToFront
```
public void bringToFront(PaneObject o)
```
    Moves a pane object to front of all other pane objects.
    
    Parameters:
    
    o - the pane object that will be moved
  - bringToBack
```
public void bringToBack(PaneObject o)
```
    Moves a pane object to back of all other pane objects.
    
    Parameters:
    
    o - the pane object that will be moved
  - bringToFrontOf
```
public void bringToFrontOf(PaneObject o,
                           PaneObject location)
```
    Moves a pane object to front of another pane object.
    
    Parameters:
    
    o - the pane object that will be moved
    
    location - the pane object to front of which the object o will be moved
  - bringToBackOf
```
public void bringToBackOf(PaneObject o,
                          PaneObject location)
```
    Moves a pane object to back of another pane object.
    
    Parameters:
    
    o - the pane object that will be moved
    
    location - the pane object to back of which the object o will be moved
  - getTurtles
```
public Turtle[] getTurtles()
```
    Gets an array of turtles currently living in this pane.
    
    Returns:
    
    the array referencing all turtles in this pane.
  - getTurtleCount
```
public int getTurtleCount()
```
    Gets the number of turtles currently living in this pane.
    
    Returns:
    
    the number of turtles in this pane.
  - getTurtle
```
public Turtle getTurtle(int index)
```
    Gets the turtle associated with the specified index.
    
    Parameters:
    
    index - the position of the turtle.
    
    Returns:
    
    a turtle that is associated with the specified index.
  - getPanes
```
public Pane[] getPanes()
```
    Gets an array of children panes currently living in this pane.
    
    Returns:
    
    the array referencing all panes in this pane.
  - getPaneCount
```
public int getPaneCount()
```
    Gets the number of children panes currently living in this pane.
    
    Returns:
    
    the number of panes in this pane.
  - getPane
```
public Pane getPane(int index)
```
    Gets the pane associated with the specified index.
    
    Parameters:
    
    index - the position of the pane.
    
    Returns:
    
    a pane that is associated with the specified index.
  - getPaneObjects
```
public PaneObject[] getPaneObjects()
```
    Gets an array of all children object currently living in this pane.
    
    Returns:
    
    the array referencing all pane objects in this pane.
  - getObjectCount
```
public int getObjectCount()
```
    Gets the number of children objects currently living in this pane.
    
    Returns:
    
    the number of pane objects in this panes.
  - getPaneObject
```
public PaneObject getPaneObject(int index)
```
    Gets the pane object associated with the specified index.
    
    Parameters:
    
    index - the position of the pane object.
    
    Returns:
    
    a pane object that is associated with the specified index.
  - isMouseTransparent
```
public boolean isMouseTransparent()
```
    Returns whether the pane is transparent for mouse events. If the pane is transparent for mouse events the any mouse event is forwarded also to panes under this pane.
    
    Returns:
    
    true, if the pane is mouse transparent, false otherwise.
  - setMouseTransparent
```
public void setMouseTransparent(boolean mouseTransparent)
```
    Sets transparency of the pane for mouse events. If the pane is transparent for mouse events the any mouse event is forwarded also to panes under this pane.
    
    Parameters:
    
    mouseTransparent - true for mouse transparent pane, false otherwise.
  - setKeyRepeatPeriod
```
public void setKeyRepeatPeriod(long keyRepeatPeriod)
```
    Sets the period in which key pressed events are generated for key codes that are hold.
    
    Parameters:
    
    keyRepeatPeriod - the period in milliseconds. 0 for default strategy (defined by OS or JRE).
  - getKeyRepeatPeriod
```
public long getKeyRepeatPeriod()
```
    Returns the period in which key pressed events are generated for key codes that are hold.
    
    Returns:
    
    the period in milliseconds or 0 for default strategy (defined by OS or JRE).
  - setKeyRepeatPeriod
```
public void setKeyRepeatPeriod(int keyCode,
                               long keyRepeatPeriod)
```
    Sets the period in which key pressed events are generated for given key code when it is hold.
    
    Parameters:
    
    keyCode - the key code.
    
    keyRepeatPeriod - the period in milliseconds. 0 for default strategy (defined by OS or JRE).
  - getKeyRepeatPeriod
```
public long getKeyRepeatPeriod(int keyCode)
```
    Returns the period in which key pressed events are generated for given key code when it is hold.
    
    Parameters:
    
    keyCode - the key code
    
    Returns:
    
    the period in milliseconds or 0 for default strategy (defined by OS or JRE).
  - onMouseClicked
```
protected void onMouseClicked(int x,
                              int y,
                              MouseEvent detail)
```
    Called on mouse clicked event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the mouse click with respect to pane coordinate system.
    
    y - the Y-coordinate of the mouse click with respect to pane coordinate system.
    
    detail - the additional information about the event.
  - onMouseMoved
```
protected void onMouseMoved(int x,
                            int y,
                            MouseEvent detail)
```
    Called on mouse moved event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the mouse with respect to pane coordinate system
    
    y - the Y-coordinate of the mouse with respect to pane coordinate system
    
    detail - the additional information about the event
  - onMouseDragged
```
protected void onMouseDragged(int x,
                              int y,
                              MouseEvent detail)
```
    Called on mouse dragged event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the mouse with respect to pane coordinate system.
    
    y - the Y-coordinate of the mouse with respect to pane coordinate system.
    
    detail - the additional information about the event.
  - onMousePressed
```
protected void onMousePressed(int x,
                              int y,
                              MouseEvent detail)
```
    Called on mouse pressed event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the mouse with respect to pane coordinate system.
    
    y - the Y-coordinate of the mouse with respect to pane coordinate system.
    
    detail - the additional information about the event.
  - onMouseReleased
```
protected void onMouseReleased(int x,
                               int y,
                               MouseEvent detail)
```
    Called on mouse released event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the mouse with respect to pane coordinate system.
    
    y - the Y-coordinate of the mouse with respect to pane coordinate system.
    
    detail - the additional information about the event.
  - onKeyPressed
```
protected void onKeyPressed(KeyEvent e)
```
    Called on key pressed event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    e - the additional information about the event.
  - onKeyReleased
```
protected void onKeyReleased(KeyEvent e)
```
    Called on key released event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    e - the additional information about the event.
  - onKeyTyped
```
protected void onKeyTyped(KeyEvent e)
```
    Called on key typed event. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    e - the additional information about the event.
  - canClick
```
public boolean canClick(int x,
                        int y,
                        boolean inParentCoordinates)
```
    Returns whether a point at given location is clickable, i.e., a hand mouse cursor should be shown over this point. This method can be called only from Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the location with respect to specified coordinate system.
    
    y - the Y-coordinate of the location with respect to specified coordinate system.
    
    inParentCoordinates - a boolean that determines coordinate system of given coordinates. True, if the coordinates are in coordinate system of the parent pane, false, if the coordinates are in coordinate system of this pane.
    
    Returns:
    
    true, if a point at given location can be clicked (i.e., a hand mouse cursor should be displayed), false otherwise.
  - onCanClick
```
protected boolean onCanClick(int x,
                             int y)
```
    Called when querying whether a point at given location can be clicked. This method is called in order to display an appropriate mouse cursor. If this method is not overridden, it returns whether at given location is an object that is clickable considering all panes to be mouse transparent. The method is invoked in the Swing's EDT.
    
    Parameters:
    
    x - the X-coordinate of the location with respect to pane coordinate system.
    
    y - the Y-coordinate of the location with respect to pane coordinate system.
    
    Returns:
    
    true, if a point at given location can be clicked (i.e., a hand mouse cursor should be displayed), false otherwise.
  - draw
```
public void draw(Shape shape,
                 Stroke stroke,
                 Color color,
                 Paint paint)
```
    Draws the shape to the pane.
    
    Parameters:
    
    shape - the shape to be drawn
    
    stroke - the stroke used to draw the shape
    
    color - the color used to draw the shape
    
    paint - the color used to paint the shape
  - fill
```
public void fill(Shape shape,
                 Stroke stroke,
                 Color color,
                 Paint paint)
```
    Fills the shape to the pane.
    
    Parameters:
    
    shape - the shape to be drawn
    
    stroke - the stroke used to draw the shape
    
    color - the color used to draw the shape
    
    paint - the color used to paint the shape
  - getTickPeriod
```
public long getTickPeriod()
```
    Gets the time period (in milliseconds) in which the onTick method is executed. The value 0 indicates disabled periodical execution of the onTick method.
    
    Returns:
    
    the tick period in milliseconds.
  - setTickPeriod
```
public void setTickPeriod(long tickPeriod)
```
    Sets the time period (in milliseconds) in which the onTick method is executed. The value 0 indicates disabled periodical execution of the onTick method.
    
    Parameters:
    
    tickPeriod - the tick period in milliseconds.
  - onTick
```
protected void onTick()
```
    Called periodically by the pane. The period of calling is determined by the property tickPeriod.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - savePicture
```
public boolean savePicture(String filename)
```
    Stores picture of the pane to an image file.
    
    Parameters:
    
    filename - the name of the output image file.
    
    Returns:
    
    true, if the picture has been saved, false otherwise.

Class Pane

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

referenceIdentification

Constructor Detail

Pane

Pane

Pane

Method Detail

getWidth

setWidth

getHeight

setHeight

getX

setX

getY

setY

getXCenter

setXCenter

getYCenter

setYCenter

setCenter

getCenter

getRotation

setRotation

resize

setPosition

setPosition

getPosition

setCenter

containsPoint

getBorderWidth

setBorderWidth

getBorderColor

setBorderColor

getTransparency

setTransparency

getBackgroundColor

setBackgroundColor

isTransparentBackground

setTransparentBackground

isAntialiased

setAntialiased

paintToPaneGraphics

invalidate

clear

getPane

setPane

add

isTurtleCentering

setTurtleCentering

remove

bringToFront

bringToBack

bringToFrontOf

bringToBackOf

getTurtles

getTurtleCount

getTurtle

getPanes

getPaneCount

getPane

getPaneObjects

getObjectCount

getPaneObject

isMouseTransparent

setMouseTransparent

setKeyRepeatPeriod

getKeyRepeatPeriod

setKeyRepeatPeriod

getKeyRepeatPeriod

onMouseClicked

onMouseMoved

onMouseDragged

onMousePressed

onMouseReleased

onKeyPressed