Class RMEditorShapes
- java.lang.Object
-
- com.inductiveautomation.rm.editor.RMEditorShapes
-
public class RMEditorShapes extends java.lang.Object
Handles editor methods specific to clipboard operations (cut, copy paste).
-
-
Constructor Summary
Constructors Constructor Description RMEditorShapes(RMEditor anEditor)
Creates a new editor shapes helper.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
addImagePlaceholder(RMEditor anEditor)
Adds an image placeholder to the given editor.static void
addSubreport(RMEditor anEditor)
Adds a subreport to the given editor.static void
bringToFront(RMEditor anEditor)
Orders all currently selected shapes to the front.static void
combinePaths(RMEditor anEditor)
Create new shape by coalescing the outer perimeters of the currently selected shapes.static void
convertToImage(RMEditor anEditor)
Converts currently selected shape to image.static void
equallySpaceColumn(RMEditor anEditor)
Arranges currently selected shapes such that they have the same vertical distance between them.static void
equallySpaceRow(RMEditor anEditor)
Arranges currently selected shapes such that they have the same horizontal distance between them.static RMTypes.AlignX
getAlignmentX(RMEditor anEditor)
Returns the horizontal alignment of the text of the currently selected shapes.static float
getCharSpacing(RMEditor anEditor)
Returns the characters spacing for the currently selected shape.RMEditor
getEditor()
Returns the editor.static RMFont
getFont(RMEditor anEditor)
Returns the font of editor's selected shape.static RMFormat
getFormat(RMEditor anEditor)
Returns the format of the editor's selected shape.static float
getLineGap(RMEditor anEditor)
Returns the line gap at char 0 (or selected char, if editing).static float
getLineHeightMax(RMEditor anEditor)
Returns the maximum line height at char 0 (or selected char, if editing).static float
getLineHeightMin(RMEditor anEditor)
Returns the minimum line height at char 0 (or selected char, if editing).static float
getLineSpacing(RMEditor anEditor)
Returns the line spacing at char 0 (or selected char, if editing).static RMXString.Outline
getOutline(RMEditor anEditor)
Returns the outline state of the currently selected shape (null if none).static RMColor
getSelectedColor(RMEditor anEditor)
Returns the specified type of color (text, stroke or fill) of editor's selected shape.static void
groupInAnimationPath(RMEditor anEditor)
Creates an animation path from the selected shapes.static void
groupInMorphShape(RMEditor anEditor)
Adds the selected shapes to a Morph Shape.static void
groupInPainterShape(RMEditor anEditor)
Converts the currently selected shapes to a artist shape.static void
groupInPanel(RMEditor anEditor)
Group currently selected shapes in panel.static void
groupInScene3D(RMEditor anEditor)
Adds the selected shapes to a Scene3D Shape.static void
groupInScrollPane(RMEditor anEditor)
Group currently selected RJShapes in RJScrollPane.static void
groupInSwitchShape(RMEditor anEditor)
Adds the selected shapes to a Switch Shape.static void
groupInTabbedPane(RMEditor anEditor)
Group currently selected shapes in tabbed pane.static void
groupShapes(RMEditor anEditor, java.util.List<? extends RMShape> theShapes, RMParentShape aGroupShape)
Groups the given shape list to the given group shape.static boolean
isUnderlined(RMEditor anEditor)
Returns whether the currently selected shape is underlined.static void
makeColumnCenter(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their center.static void
makeColumnLeft(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their left border.static void
makeColumnRight(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their right border.static void
makeRowBottom(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their bottom.static void
makeRowCenter(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their center.static void
makeRowTop(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their top.static void
makeSameHeight(RMEditor anEditor)
Makes currently selected shapes all have the same height as the first selected shape.static void
makeSameSize(RMEditor anEditor)
Makes currently selected shapes all have the same width and height as the first selected shape.static void
makeSameWidth(RMEditor anEditor)
Makes currently selected shapes all have the same width as the first selected shape.static void
moveDownOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point down.static void
moveLeftOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point to the left.static void
moveRightOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point to the right.static void
moveToNewLayer(RMEditor anEditor)
Moves all the currently selected shapes to a new page layer.static void
moveUpOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point up.static void
runDatasetKeyPanel(RMEditor anEditor, java.lang.String aKeyPath)
Runs the dataset key panel to add a table, graph, crosstab or labels to given editor.static void
sendToBack(RMEditor anEditor)
Orders all currently selected shapes to the back.static void
setAlignmentX(RMEditor anEditor, RMTypes.AlignX anAlign)
Sets the horizontal alignment of the text of the currently selected shapes.static void
setCharSpacing(RMEditor anEditor, float aValue)
Sets the character spacing for the currently selected shapes.static void
setColor(RMEditor anEditor, RMColor aColor)
Sets the fill color of the editor's selected shapes.static void
setFontBold(RMEditor anEditor, boolean aFlag)
Sets the "boldness" of text in the currently selected shapes.static void
setFontFamily(RMEditor anEditor, RMFont aFont)
Sets the font family of editor's selected shape(s).static void
setFontItalic(RMEditor anEditor, boolean aFlag)
Sets the italic state of text in the currently selected shapes.static void
setFontName(RMEditor anEditor, RMFont aFont)
Sets the font name of editor's selected shape(s).static void
setFontSize(RMEditor anEditor, float aSize, boolean isRelative)
Sets the font size of editor's selected shape(s).static void
setFormat(RMEditor anEditor, RMFormat aFormat)
Sets the format of editor's selected shape(s).static void
setLineGap(RMEditor anEditor, float aHeight)
Sets the line gap for all chars (or all selected chars, if editing).static void
setLineHeightMax(RMEditor anEditor, float aHeight)
Sets the maximum line height for all chars (or all selected chars, if eiditing).static void
setLineHeightMin(RMEditor anEditor, float aHeight)
Sets the minimum line height for all chars (or all selected chars, if editing).static void
setLineSpacing(RMEditor anEditor, float aHeight)
Sets the line spacing for all chars (or all selected chars, if editing).static void
setOutline(RMEditor anEditor)
Sets the currently selected shapes to be outlined.static void
setOutline(RMEditor anEditor, RMXString.Outline anOutline)
Sets the outline state of the currently selected shapes.static void
setSelectedColor(RMEditor anEditor, RMColor aColor)
Sets the specified type of color (text, stroke or fill) of editor's selected shape.static void
setSizeToFit(RMEditor anEditor)
Makes currently selected shapes size to fit content.static void
setStrokeColor(RMEditor anEditor, RMColor aColor)
Sets the stroke color of the editor's selected shapes.static void
setSubscript(RMEditor anEditor)
Sets the currently selected shapes to show text as subscript.static void
setSuperscript(RMEditor anEditor)
Sets the currently selected shapes to show text as superscript.static void
setTextColor(RMEditor anEditor, RMColor aColor)
Sets the text color of the editor's selected shapes.static void
setUnderlined(RMEditor anEditor)
Sets the currently selected shapes to be underlined.static void
splitHorizontal(RMEditor editor)
Splits the selected shape in half on the horizontal axis.static void
subtractPaths(RMEditor anEditor)
Create new shape by coalescing the outer perimeters of the currently selected shapes.static void
ungroupShapes(RMEditor anEditor)
Ungroups any currently selected group shapes.
-
-
-
Constructor Detail
-
RMEditorShapes
public RMEditorShapes(RMEditor anEditor)
Creates a new editor shapes helper.
-
-
Method Detail
-
getEditor
public RMEditor getEditor()
Returns the editor.
-
groupShapes
public static void groupShapes(RMEditor anEditor, java.util.List<? extends RMShape> theShapes, RMParentShape aGroupShape)
Groups the given shape list to the given group shape. If given shapes list is null, use editor selected shapes. If given group shape is null, create new generic group shape.
-
ungroupShapes
public static void ungroupShapes(RMEditor anEditor)
Ungroups any currently selected group shapes.
-
bringToFront
public static void bringToFront(RMEditor anEditor)
Orders all currently selected shapes to the front.
-
sendToBack
public static void sendToBack(RMEditor anEditor)
Orders all currently selected shapes to the back.
-
makeRowTop
public static void makeRowTop(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their top.
-
makeRowCenter
public static void makeRowCenter(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their center.
-
makeRowBottom
public static void makeRowBottom(RMEditor anEditor)
Arranges currently selected shapes in a row relative to their bottom.
-
makeColumnLeft
public static void makeColumnLeft(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their left border.
-
makeColumnCenter
public static void makeColumnCenter(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their center.
-
makeColumnRight
public static void makeColumnRight(RMEditor anEditor)
Arranges currently selected shapes in a column relative to their right border.
-
makeSameSize
public static void makeSameSize(RMEditor anEditor)
Makes currently selected shapes all have the same width and height as the first selected shape.
-
makeSameWidth
public static void makeSameWidth(RMEditor anEditor)
Makes currently selected shapes all have the same width as the first selected shape.
-
makeSameHeight
public static void makeSameHeight(RMEditor anEditor)
Makes currently selected shapes all have the same height as the first selected shape.
-
setSizeToFit
public static void setSizeToFit(RMEditor anEditor)
Makes currently selected shapes size to fit content.
-
equallySpaceRow
public static void equallySpaceRow(RMEditor anEditor)
Arranges currently selected shapes such that they have the same horizontal distance between them.
-
equallySpaceColumn
public static void equallySpaceColumn(RMEditor anEditor)
Arranges currently selected shapes such that they have the same vertical distance between them.
-
groupInSwitchShape
public static void groupInSwitchShape(RMEditor anEditor)
Adds the selected shapes to a Switch Shape.
-
groupInScene3D
public static void groupInScene3D(RMEditor anEditor)
Adds the selected shapes to a Scene3D Shape.
-
groupInMorphShape
public static void groupInMorphShape(RMEditor anEditor)
Adds the selected shapes to a Morph Shape.
-
groupInAnimationPath
public static void groupInAnimationPath(RMEditor anEditor)
Creates an animation path from the selected shapes.
-
groupInPainterShape
public static void groupInPainterShape(RMEditor anEditor)
Converts the currently selected shapes to a artist shape.
-
combinePaths
public static void combinePaths(RMEditor anEditor)
Create new shape by coalescing the outer perimeters of the currently selected shapes.
-
subtractPaths
public static void subtractPaths(RMEditor anEditor)
Create new shape by coalescing the outer perimeters of the currently selected shapes.
-
convertToImage
public static void convertToImage(RMEditor anEditor)
Converts currently selected shape to image.
-
moveRightOnePoint
public static void moveRightOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point to the right.
-
moveLeftOnePoint
public static void moveLeftOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point to the left.
-
moveUpOnePoint
public static void moveUpOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point up.
-
moveDownOnePoint
public static void moveDownOnePoint(RMEditor anEditor)
Moves all the currently selected shapes one point down.
-
moveToNewLayer
public static void moveToNewLayer(RMEditor anEditor)
Moves all the currently selected shapes to a new page layer.
-
getSelectedColor
public static RMColor getSelectedColor(RMEditor anEditor)
Returns the specified type of color (text, stroke or fill) of editor's selected shape.
-
setSelectedColor
public static void setSelectedColor(RMEditor anEditor, RMColor aColor)
Sets the specified type of color (text, stroke or fill) of editor's selected shape.
-
setColor
public static void setColor(RMEditor anEditor, RMColor aColor)
Sets the fill color of the editor's selected shapes.
-
setStrokeColor
public static void setStrokeColor(RMEditor anEditor, RMColor aColor)
Sets the stroke color of the editor's selected shapes.
-
setTextColor
public static void setTextColor(RMEditor anEditor, RMColor aColor)
Sets the text color of the editor's selected shapes.
-
getFont
public static RMFont getFont(RMEditor anEditor)
Returns the font of editor's selected shape.
-
setFontFamily
public static void setFontFamily(RMEditor anEditor, RMFont aFont)
Sets the font family of editor's selected shape(s).
-
setFontName
public static void setFontName(RMEditor anEditor, RMFont aFont)
Sets the font name of editor's selected shape(s).
-
setFontSize
public static void setFontSize(RMEditor anEditor, float aSize, boolean isRelative)
Sets the font size of editor's selected shape(s).
-
setFontBold
public static void setFontBold(RMEditor anEditor, boolean aFlag)
Sets the "boldness" of text in the currently selected shapes.
-
setFontItalic
public static void setFontItalic(RMEditor anEditor, boolean aFlag)
Sets the italic state of text in the currently selected shapes.
-
isUnderlined
public static boolean isUnderlined(RMEditor anEditor)
Returns whether the currently selected shape is underlined.
-
setUnderlined
public static void setUnderlined(RMEditor anEditor)
Sets the currently selected shapes to be underlined. If a Table or Table Row is selected it will toggle all the child shapes to be underlined based on the underlined state of the first child with text in it.
-
getOutline
public static RMXString.Outline getOutline(RMEditor anEditor)
Returns the outline state of the currently selected shape (null if none).
-
setOutline
public static void setOutline(RMEditor anEditor)
Sets the currently selected shapes to be outlined.
-
setOutline
public static void setOutline(RMEditor anEditor, RMXString.Outline anOutline)
Sets the outline state of the currently selected shapes.
-
getAlignmentX
public static RMTypes.AlignX getAlignmentX(RMEditor anEditor)
Returns the horizontal alignment of the text of the currently selected shapes.
-
setAlignmentX
public static void setAlignmentX(RMEditor anEditor, RMTypes.AlignX anAlign)
Sets the horizontal alignment of the text of the currently selected shapes.
-
setSuperscript
public static void setSuperscript(RMEditor anEditor)
Sets the currently selected shapes to show text as superscript.
-
setSubscript
public static void setSubscript(RMEditor anEditor)
Sets the currently selected shapes to show text as subscript.
-
getCharSpacing
public static float getCharSpacing(RMEditor anEditor)
Returns the characters spacing for the currently selected shape.
-
setCharSpacing
public static void setCharSpacing(RMEditor anEditor, float aValue)
Sets the character spacing for the currently selected shapes.
-
getLineSpacing
public static float getLineSpacing(RMEditor anEditor)
Returns the line spacing at char 0 (or selected char, if editing).
-
setLineSpacing
public static void setLineSpacing(RMEditor anEditor, float aHeight)
Sets the line spacing for all chars (or all selected chars, if editing).
-
getLineGap
public static float getLineGap(RMEditor anEditor)
Returns the line gap at char 0 (or selected char, if editing).
-
setLineGap
public static void setLineGap(RMEditor anEditor, float aHeight)
Sets the line gap for all chars (or all selected chars, if editing).
-
getLineHeightMin
public static float getLineHeightMin(RMEditor anEditor)
Returns the minimum line height at char 0 (or selected char, if editing).
-
setLineHeightMin
public static void setLineHeightMin(RMEditor anEditor, float aHeight)
Sets the minimum line height for all chars (or all selected chars, if editing).
-
getLineHeightMax
public static float getLineHeightMax(RMEditor anEditor)
Returns the maximum line height at char 0 (or selected char, if editing).
-
setLineHeightMax
public static void setLineHeightMax(RMEditor anEditor, float aHeight)
Sets the maximum line height for all chars (or all selected chars, if eiditing).
-
getFormat
public static RMFormat getFormat(RMEditor anEditor)
Returns the format of the editor's selected shape.
-
setFormat
public static void setFormat(RMEditor anEditor, RMFormat aFormat)
Sets the format of editor's selected shape(s).
-
splitHorizontal
public static void splitHorizontal(RMEditor editor)
Splits the selected shape in half on the horizontal axis.
-
addImagePlaceholder
public static void addImagePlaceholder(RMEditor anEditor)
Adds an image placeholder to the given editor.
-
addSubreport
public static void addSubreport(RMEditor anEditor)
Adds a subreport to the given editor.
-
runDatasetKeyPanel
public static void runDatasetKeyPanel(RMEditor anEditor, java.lang.String aKeyPath)
Runs the dataset key panel to add a table, graph, crosstab or labels to given editor.
-
groupInPanel
public static void groupInPanel(RMEditor anEditor)
Group currently selected shapes in panel.
-
groupInTabbedPane
public static void groupInTabbedPane(RMEditor anEditor)
Group currently selected shapes in tabbed pane.
-
groupInScrollPane
public static void groupInScrollPane(RMEditor anEditor)
Group currently selected RJShapes in RJScrollPane.
-
-