Class StencilBaseEditor

The core stencil editor class for most stencil types.

Hierarchy

Constructors

constructor

Properties

_connectorOutline? _container _controlBox _gripBox _isFocused _isSelected _language _overlayContainer _portBox _state _stencil _stencilType _suppressStencilCreateEvent activeGrip? manipulationStartHeight manipulationStartLeft manipulationStartTop manipulationStartWidth manipulationStartX manipulationStartY offsetX offsetY onStencilChanged? onStencilCreated? portConnectors resizeGrips

Accessors

container isFocused isSelected overlayContainer propertyPanels settings state stencil

Methods

blur create dblClick deselect findGripByVisual focus getTargetPort hideControlBox hidePortBox initManipulation manipulate moveStencilTo ownsTarget pointerDown pointerUp resize restoreState scale select setSize setupVisuals showControlBox showPortBox switchConnectModeOff switchToConnectMode

Constructors

constructor

Properties

Protected Optional _connectorOutline

_connectorOutline?: SVGPathElement

Outline displayed in "connect" mode.

Protected _container

_container: SVGGElement

SVG container for the stencil's and editor's visual elements.

Protected _controlBox

_controlBox: SVGGElement = ...

SVG group holding editor's control box.

Protected _gripBox

_gripBox: SVGGElement = ...

SVG group holding resize grips.

Protected _isFocused

_isFocused: boolean = false

Is stencil in focus?

Protected _isSelected

_isSelected: boolean = false

Is stencil selected?

Protected _language

_language: Language

Language (localization) subsystem.

Protected _overlayContainer

_overlayContainer: HTMLDivElement

Overlay container for HTML elements like text editors, etc.

Protected _portBox

_portBox: SVGGElement = ...

SVG group for holding connector ports.

Protected _state

_state: StencilEditorState = 'new'

Editor's state.

Protected _stencil

_stencil: StencilBase

Stencil being edited.

Protected _stencilType

_stencilType: typeof StencilBase

Type of the edited stencil.

Protected _suppressStencilCreateEvent

_suppressStencilCreateEvent: boolean = false

When set to true stencilcreate event isn't fired.

Protected Optional activeGrip

activeGrip?: ResizeGrip

Currently active grip.

Protected manipulationStartHeight

manipulationStartHeight: number = 0

Height at the start of manipulation.

Protected manipulationStartLeft

manipulationStartLeft: number = 0

x coordinate of the top-left corner at the start of manipulation.

Protected manipulationStartTop

manipulationStartTop: number = 0

y coordinate of the top-left corner at the start of manipulation.

Protected manipulationStartWidth

manipulationStartWidth: number = 0

Width at the start of manipulation.

Protected manipulationStartX

manipulationStartX: number = 0

x coordinate of the pointer at the start of manipulation.

Protected manipulationStartY

manipulationStartY: number = 0

y coordinate of the pointer at the start of manipulation.

Protected offsetX

offsetX: number = 0

Pointer's horizontal distance from the top left corner.

Protected offsetY

offsetY: number = 0

Pointer's vertical distance from the top left corner.

Optional onStencilChanged

onStencilChanged?: ((stencilEditor) => void)

Type declaration

    • (stencilEditor): void

    • Fired when stencil changes.

      Parameters

      Returns void

Optional onStencilCreated

onStencilCreated?: ((stencilEditor) => void)

Type declaration

    • (stencilEditor): void

    • Fired when stencil is created.

      Parameters

      Returns void

Protected portConnectors

portConnectors: Map<PortLocation, PortConnector> = ...

Collection of ports.

Protected resizeGrips

resizeGrips: Map<GripLocation, ResizeGrip> = ...

Resize grips.

Accessors

container

  • get container(): SVGGElement

  • Returns the SVG container for the stencil's and editor's visual elements.

    Returns SVGGElement

isFocused

  • get isFocused(): boolean

  • Returns true if the stencil is in focus.

    Returns boolean

isSelected

  • get isSelected(): boolean

  • Returns true if the stencil is selected.

    Returns boolean

overlayContainer

  • get overlayContainer(): HTMLDivElement

  • Overlay container for HTML elements like text editors, etc.

    Returns HTMLDivElement

propertyPanels

Protected settings

state

stencil

Methods

blur

  • Unfocus the stencil.

    Returns void

create

  • Creates a stencil at specified location.

    Parameters

    • point: IPoint

      location at which to create the stencil.

    Returns void

dblClick

  • Handles a double-click event.

    Parameters

    • point: IPoint

      pointer location.

    • Optional target: EventTarget

      pointer event target.

    Returns void

deselect

  • Deselect the stencil.

    Returns void

Protected findGripByVisual

  • Finds a resize grip by the target visual.

    Parameters

    • target: SVGGraphicsElement

      event target.

    Returns undefined | ResizeGrip

    resize grip or undefined if not found.

focus

  • Puts the stencil editor in focus.

    Returns void

getTargetPort

  • Returns a port under the current pointer.

    Parameters

    • ev: null | PointerEvent

      pointer event.

    • exact: boolean = true

      if true, returns the port exactly under the pointer, otherwise - closest.

    • zoomLevel: number = 1

      current zoom level.

    Returns undefined | PortConnector

    target port.

Protected hideControlBox

  • Hides the control box.

    Returns void

Protected hidePortBox

  • Hides the port box.

    Returns void

initManipulation

  • Initial actions when manipulation starts.

    Parameters

    • point: IPoint

      pointer location

    Returns void

manipulate

  • Handles manipulation.

    Parameters

    • point: IPoint

      pointer location.

    Returns void

moveStencilTo

  • Moves the stencil to specified location.

    Parameters

    • Optional x: number

      horizontal location.

    • Optional y: number

      vertical location.

    Returns void

ownsTarget

  • Returns true if the element belongs to the stencil or the editor.

    Parameters

    • el: null | EventTarget

      target element.

    Returns boolean

    true if the element belongs to the stencil or editor.

pointerDown

  • Handles a pointerdown event.

    Parameters

    • point: IPoint

      pointer location.

    • Optional target: EventTarget

      event target element.

    Returns void

pointerUp

  • Parameters

    Returns void

Protected resize

  • Resizes the stencil.

    Parameters

    • point: IPoint

      pointer location.

    Returns void

restoreState

  • Restores the stencil from previously saved state.

    Parameters

    Returns void

scale

  • Scales the editor and stencil.

    Parameters

    • scaleX: number

      horizontal scale factor.

    • scaleY: number

      vertical scale factor.

    Returns void

select

  • Select the stencil.

    Returns void

Protected setSize

  • Adjusts stencil and editor size.

    Returns void

Protected setupVisuals

  • Creates visuals for the stencil and editor.

    Returns void

Protected showControlBox

  • Shows the control box.

    Returns void

Protected showPortBox

  • Shows the port box.

    Returns void

switchConnectModeOff

  • Switches the stencil editor out of the connect mode.

    Returns void

switchToConnectMode

  • Switches the stencil editor to connect mode.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc