Package com.inductiveautomation.rm.shape

Class RMPageLayer

java.lang.Object
com.inductiveautomation.rm.base.RMListenerList
com.inductiveautomation.rm.base.RMObject
com.inductiveautomation.rm.shape.RMPageLayer
All Implemented Interfaces:
RMPropertyChanger, Cloneable
public class RMPageLayer extends RMObject
This class represents a page layer, a standard feature of page layout applications that lets you manage the children of a page as separate groups, so that some can be made unselectable or invisible to ease template editing.

  • Field Details

  • Constructor Details

    • RMPageLayer

      public RMPageLayer()
      Creates a plain layer.

    • RMPageLayer

      public RMPageLayer(RMPage aPage, String aName)
      Creates a page layer for a given page and name.

  • Method Details

    • getPage

      public RMPage getPage()
      Returns the page associated with this layer.

    • getName

      public String getName()
      Returns the layer's name.

    • setName

      public void setName(String aName)
      Sets the layer's name.

    • isVisible

      public boolean isVisible()
      Returns whether this layer is to be drawn.

    • setVisible

      public void setVisible(boolean aFlag)
      Sets whether this layer is to be drawn.

    • isLocked

      public boolean isLocked()
      Returns whether this layer is editable.

    • setLocked

      public void setLocked(boolean aFlag)
      Sets whether this layer is editable.

    • isSelectable

      public boolean isSelectable()
      Sets whether this layer is selectable.

    • getLayerState

      public int getLayerState()
      Returns the state of this layer (locked, visible, invisible).

    • setLayerState

      public void setLayerState(int aState)
      Returns the state of this layer (locked, visible, invisible).

    • getChildCount

      public int getChildCount()
      Returns the number of children in this layer.

    • getChild

      public RMShape getChild(int anIndex)
      Returns the specific child of this layer at the given index.

    • getChildren

      public List<RMShape> getChildren()
      Returns the list of children for this layer.

    • addChild

      public void addChild(RMShape aChild)
      Adds a child to this layer.

    • addChild

      public void addChild(RMShape aChild, int anIndex)
      Adds a child to this layer at the given index.

    • removeChild

      public Object removeChild(int anIndex)
      Removes a child from this layer.

    • removeChild

      public int removeChild(RMShape aChild)
      Removes a child from this layer.

    • addChildren

      public void addChildren(List<RMShape> theShapes)
      Adds a list of children to this layer.

    • removeChildren

      public void removeChildren(List<RMShape> theShapes)
      Removes a list of children from this layer.

    • removeChildren

      public void removeChildren()
      Removes all children from this layer.

    • getIndex

      public int getIndex()
      Returns the index of this layer in its page.

    • getChildIndex

      public int getChildIndex(RMShape aChild)
      Returns the index of a given child.

    • getPageChildIndex

      public int getPageChildIndex()
      Returns the index of this layer's first child in the page.

    • bringShapesToFront

      public void bringShapesToFront(List shapes)
      Moves the shapes specified in the given list to the front of this layer's list of shapes.

    • sendShapesToBack

      public void sendShapesToBack(List shapes)
      Moves the shapes specified in the given list to the back of this layer's list of shapes.

    • clone

      public Object clone()
      Standard clone implementation.
      Overrides:
      clone in class RMListenerList