Package com.ribsapp.shapes

Class RJShape

java.lang.Object

com.reportmill.base.RMObject

com.reportmill.shape.RMShape

com.ribsapp.shapes.RJShape

All Implemented Interfaces:

RMArchiver.Archiving, RMShapePainter.Paint, RJMinMaxSizeSettable, java.lang.Cloneable

Direct Known Subclasses:

JProgressBarShape, JScrollPaneShape, JSeparatorShape, JSliderShape, JSpinnerShape, JSplitPaneShape, JTabbedPaneShape, JTableShape, JTreeShape, RJColorDockShape, RJColorWellShape, RJCustomViewShape, RJPanelShape, RJSwitchPaneShape, RJTextShape, RJThumbWheelShape

public class RJShape
extends RMShape
implements RMShapePainter.Paint, RJMinMaxSizeSettable

An RMShape subclass to represent Swing components.

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors

Constructor	Description
RJShape()	Creates a new RJShape.
RJShape(javax.swing.JComponent aComponent)	Creates a new RJShape for the given component.

Method Summary

Modifier and Type	Method	Description
boolean	acceptsDrag(java.awt.dnd.DropTargetDragEvent dragEvent)	Implemented by shapes that can handle drag & drop
java.lang.Object	clone()	Standard clone implementation.
RMShape	cloneDeep()	For clone deep, lets just archive and unarchive component, and get shape hieracrhy from it.
void	dragAtPoint(java.awt.dnd.DropTargetDragEvent dragEvent, RMPoint aPoint)	Editor method - called by RBEditor when system does DnD over shape.
void	dragExit()	Editor method.
void	dropAtPoint(java.awt.dnd.DropTargetDropEvent dropEvent, RMPoint aPoint)	Editor method.
void	dropKeyAtPoint(java.lang.String aKey, RMPoint aPoint)	Editor method.
boolean	equals(java.lang.Object anObj)	Standard equals implementation.
RJPanel	findParentPanel()	Walks up the shape hierarchy looking for the first ancestor of this shape which is an RJPanel.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement)	XML unarchival.
java.lang.String	getAutosizing()	Overrides shape implementation to propagate to component.
javax.swing.border.Border	getBorder()	Returns the Swing border for this shape.
RMRect	getBoundsInsideInset()	Returns the bounds of the shape in its own coordinate system, inset by the component's Insets, if it has any.
RJShape	getChildRB(int anIndex)	Returns the individual child at the given index as an RJShape.
RMRect	getClipRect()	Implemented by sublasses to specify clipping behavior.
javax.swing.JComponent	getComponent()	Returns the RJComponent represented by this shape.
RMSize	getDefaultMaximumSize()	Get the minimum/maximum size values from the component instead of the helper.
RMSize	getDefaultMinimumSize()	Get the minimum/maximum size values from the component instead of the helper.
RMFont	getFont()	Overrides shape implementation to propagate to component.
java.awt.image.BufferedImage	getImage()	Returns the image for this shape.
RMSize	getMaximumSize()	Returns component's maximum size as an RMSize.
RMSize	getMinimumSize()	Returns component's minimum size as an RMSize.
java.lang.String	getName()	Returns the shape's component's name.
java.lang.String	getToolClassName()	Editor method - indicates that linked text should use normal text inspector.
java.lang.String	getToolTipText()	Returns the tool tip text associated with this shape's component.
void	paintImage(java.awt.Graphics2D g)	Paints the shape component image with the given graphics.
void	paintImageOverkill(java.awt.Graphics2D g)	Paints the shape component image into the given graphics in a manner more likely to always work.
void	paintShape(RMShapePainter aPainter, java.awt.Graphics2D g)	Paints the shape.
void	recache()	Resets the image represenation of this control to force it to recreate from component.
void	recacheDeep()	Recache the entire shape tree (depth first).
void	setAutosizing(java.lang.String aValue)	Overrides shape implementation to propagate to component.
void	setBorder(javax.swing.border.Border aBorder)	Sets the Swing border for this shape.
void	setClipsChildren(boolean flag)	Any shape can be set to clip to its bbox by calling setClipsChildren(true).
void	setComponent(javax.swing.JComponent aComponent)	Sets the RJComponent represented by this shape.
void	setFill(RMFill aFill)	Overrides shape implementation to propagate to component.
void	setFont(RMFont aFont)	Overrides shape implementation to propagate to component.
void	setHeight(double aValue)	Overrides shape implementation to propagate to component.
void	setMaximumSize(RMSize max)	Set component's maximum size as an RMSize
void	setMinimumSize(RMSize min)	Set component's minimum size as an RMSize.
void	setName(java.lang.String aName)	Sets the shape's component's name.
void	setToolTipText(java.lang.String aValue)	Sets the tool tip text associated with this shape's component.
void	setWidth(double aValue)	Overrides shape implementation to propagate to component.
void	setX(double aValue)	Overrides shape implementation to propagate to component.
void	setY(double aValue)	Overrides shape implementation to propagate to component.
java.lang.Object	super_fromXML(RXArchiver anArchiver, RXElement anElement)	Provides access to RMShape fromXML implementation.
RXElement	toXML(RXArchiver anArchiver)	XML archival.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsDragKeys, acceptsFormat, acceptsMouse, addChild, addChild, addChildBelowLastChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copy, copyShape, delete, didChange, divideShapeFromEdge, divideShapeFromTop, dragKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWhoDraw, getChildrenWhoHitTest, getChildSortedByX, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getMaxX, getMaxY, getOpacity, getOpacityDeep, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getXY, getXYP, getY, groupShapes, hasPageBreaks, height, indexOf, indexOf, initWithArchiver, intersects, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageBreakMax, pageBreakPageMax, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgClone, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setNeedsRepaint, setNeedsRepaint, setOpacity, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidthDeep, setWidthDeep, setWidthToFit, setXY, setXY, setXYP, sizesToFitChildren, superSelectable, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.base.RMObject

didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ribsapp.shapes.RJMinMaxSizeSettable

getSize

Constructor Detail

RJShape

public RJShape()

Creates a new RJShape.

RJShape

public RJShape(javax.swing.JComponent aComponent)

Creates a new RJShape for the given component.

Method Detail

getComponent

public javax.swing.JComponent getComponent()

Returns the RJComponent represented by this shape.

setComponent

public void setComponent(javax.swing.JComponent aComponent)

Sets the RJComponent represented by this shape.

getName

public java.lang.String getName()

Returns the shape's component's name.

Overrides:

getName in class RMShape

setName

public void setName(java.lang.String aName)

Sets the shape's component's name.

Overrides:

setName in class RMShape

setX

public void setX(double aValue)

Overrides shape implementation to propagate to component.

Overrides:

setX in class RMShape

setY

public void setY(double aValue)

Overrides shape implementation to propagate to component.

Overrides:

setY in class RMShape

setWidth

public void setWidth(double aValue)

Overrides shape implementation to propagate to component.

Overrides:

setWidth in class RMShape

setHeight

public void setHeight(double aValue)

Overrides shape implementation to propagate to component.

Overrides:

setHeight in class RMShape

setFill

public void setFill(RMFill aFill)

Overrides shape implementation to propagate to component.

Overrides:

setFill in class RMShape

getAutosizing

public java.lang.String getAutosizing()

Overrides shape implementation to propagate to component.

Overrides:

getAutosizing in class RMShape

setAutosizing

public void setAutosizing(java.lang.String aValue)

Overrides shape implementation to propagate to component.

Overrides:

setAutosizing in class RMShape

setMaximumSize

public void setMaximumSize(RMSize max)

Set component's maximum size as an RMSize

Specified by:

setMaximumSize in interface RJMinMaxSizeSettable

getMaximumSize

public RMSize getMaximumSize()

Returns component's maximum size as an RMSize.

Specified by:

getMaximumSize in interface RJMinMaxSizeSettable

setMinimumSize

public void setMinimumSize(RMSize min)

Set component's minimum size as an RMSize.

Specified by:

setMinimumSize in interface RJMinMaxSizeSettable

getMinimumSize

public RMSize getMinimumSize()

Returns component's minimum size as an RMSize.

Specified by:

getMinimumSize in interface RJMinMaxSizeSettable

getDefaultMinimumSize

public RMSize getDefaultMinimumSize()

Get the minimum/maximum size values from the component instead of the helper. If had been set previously, we'll get the last set value, otherwise it will return whatever the component's default is (on this L&F)

Specified by:

getDefaultMinimumSize in interface RJMinMaxSizeSettable

getDefaultMaximumSize

public RMSize getDefaultMaximumSize()

Get the minimum/maximum size values from the component instead of the helper. If had been set previously, we'll get the last set value, otherwise it will return whatever the component's default is (on this L&F)

Specified by:

getDefaultMaximumSize in interface RJMinMaxSizeSettable

getFont

public RMFont getFont()

Overrides shape implementation to propagate to component.

Overrides:

getFont in class RMShape

setFont

public void setFont(RMFont aFont)

Overrides shape implementation to propagate to component.

Overrides:

setFont in class RMShape

getBorder

public javax.swing.border.Border getBorder()

Returns the Swing border for this shape.

setBorder

public void setBorder(javax.swing.border.Border aBorder)

Sets the Swing border for this shape.

getToolTipText

public java.lang.String getToolTipText()

Returns the tool tip text associated with this shape's component.

setToolTipText

public void setToolTipText(java.lang.String aValue)

Sets the tool tip text associated with this shape's component.

getChildRB

public RJShape getChildRB(int anIndex)

Returns the individual child at the given index as an RJShape.

getBoundsInsideInset

public RMRect getBoundsInsideInset()

Returns the bounds of the shape in its own coordinate system, inset by the component's Insets, if it has any.

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class RMShape

cloneDeep

public RMShape cloneDeep()

For clone deep, lets just archive and unarchive component, and get shape hieracrhy from it.

Overrides:

cloneDeep in class RMShape

getClipRect

public RMRect getClipRect()

Implemented by sublasses to specify clipping behavior. Null (the default) indicates no clipping. Any other rect is interpreted as being in the parent's coordinate system.

setClipsChildren

public void setClipsChildren(boolean flag)

Any shape can be set to clip to its bbox by calling setClipsChildren(true).

paintShape

public void paintShape(RMShapePainter aPainter,
                       java.awt.Graphics2D g)

Paints the shape.

Specified by:

paintShape in interface RMShapePainter.Paint

getImage

public java.awt.image.BufferedImage getImage()

Returns the image for this shape.

recache

public void recache()

Resets the image represenation of this control to force it to recreate from component.

recacheDeep

public void recacheDeep()

Recache the entire shape tree (depth first).

paintImage

public void paintImage(java.awt.Graphics2D g)

Paints the shape component image with the given graphics.

paintImageOverkill

public void paintImageOverkill(java.awt.Graphics2D g)

Paints the shape component image into the given graphics in a manner more likely to always work.

getToolClassName

public java.lang.String getToolClassName()

Editor method - indicates that linked text should use normal text inspector.

Overrides:

getToolClassName in class RMShape

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

public java.lang.Object fromXML(RXArchiver anArchiver,
                                RXElement anElement)

XML unarchival.

Overrides:

fromXML in class RMShape

super_fromXML

public java.lang.Object super_fromXML(RXArchiver anArchiver,
                                      RXElement anElement)

Provides access to RMShape fromXML implementation.

acceptsDrag

public boolean acceptsDrag(java.awt.dnd.DropTargetDragEvent dragEvent)

Implemented by shapes that can handle drag & drop

dragAtPoint

public void dragAtPoint(java.awt.dnd.DropTargetDragEvent dragEvent,
                        RMPoint aPoint)

Editor method - called by RBEditor when system does DnD over shape.

dropAtPoint

public void dropAtPoint(java.awt.dnd.DropTargetDropEvent dropEvent,
                        RMPoint aPoint)

Editor method.

dropKeyAtPoint

public void dropKeyAtPoint(java.lang.String aKey,
                           RMPoint aPoint)

Editor method.

Overrides:

dropKeyAtPoint in class RMShape

dragExit

public void dragExit()

Editor method.

Overrides:

dragExit in class RMShape

findParentPanel

public RJPanel findParentPanel()

Walks up the shape hierarchy looking for the first ancestor of this shape which is an RJPanel.