DefaultPortCandidateDescriptor (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.DefaultPortCandidateDescriptor

All Implemented Interfaces:

IBoundsProvider, ICanvasObjectDescriptor, IHitTestable, IMarqueeTestable, IVisibilityTestable, IVisualCreator
```
public class DefaultPortCandidateDescriptor
extends Object
implements ICanvasObjectDescriptor, IVisualCreator, IBoundsProvider, IHitTestable, IVisibilityTestable, IMarqueeTestable
```
A simple ICanvasObjectDescriptor that can be used to draw IPortCandidate instances in a CanvasControl.

Field Summary

Fields
Modifier and Type	Field and Description
`static ResourceKey`	`CANDIDATE_DRAWING_INVALID_FOCUSED_KEY` A `ResourceKey` that can be used by instances of the `DefaultPortCandidateDescriptor` to look up a `IVisualTemplate` that will be used for rendering a invalid, focused `IPortCandidate`.
`static ResourceKey`	`CANDIDATE_DRAWING_INVALID_NON_FOCUSED_KEY` A `ResourceKey` that can be used by instances of the `DefaultPortCandidateDescriptor` to look up a `IVisualTemplate` that will be used for rendering an invalid, non-focused `IPortCandidate`.
`static ResourceKey`	`CANDIDATE_DRAWING_VALID_FOCUSED_KEY` A `ResourceKey` that can be used by instances of the `DefaultPortCandidateDescriptor` to look up a `IVisualTemplate` that will be used for rendering a valid, focused `IPortCandidate`.
`static ResourceKey`	`CANDIDATE_DRAWING_VALID_NON_FOCUSED_KEY` A `ResourceKey` that can be used by instances of the `DefaultPortCandidateDescriptor` to look up a `IVisualTemplate` that will be used for rendering a valid, non-focused `IPortCandidate`.

Fields inherited from interface com.yworks.yfiles.view.ICanvasObjectDescriptor
ALWAYS_DIRTY_INSTANCE, ALWAYS_DIRTY_LOOKUP, DYNAMIC_DIRTY_INSTANCE, DYNAMIC_DIRTY_LOOKUP, VISUAL, VOID

Fields inherited from interface com.yworks.yfiles.view.IBoundsProvider
EMPTY, UNBOUNDED

Fields inherited from interface com.yworks.yfiles.view.input.IHitTestable
ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.IVisibilityTestable
ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IMarqueeTestable
ALWAYS, NEVER

Constructor Summary

Constructors
Constructor and Description

DefaultPortCandidateDescriptor()
Instantiates a new descriptor.

Constructors
Constructor and Description
`DefaultPortCandidateDescriptor()` Instantiates a new descriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`createVisual(IRenderContext context)` This method is called by the framework to create a `Node` that will be included into the `IRenderContext`.
`RectD`	`getBounds(ICanvasContext context)` Returns a tight rectangular area where the whole rendering would fit into.
`IBoundsProvider`	`getBoundsProvider(Object forUserObject)` Returns an implementation of `IBoundsProvider` that can determine the visible bounds of the rendering of the user object.
`IHitTestable`	`getHitTestable(Object forUserObject)` Returns an implementation of `IHitTestable` that can determine whether the rendering of the user object has been hit at a given coordinate.
`double`	`getSize()` Gets the logical size of the candidate.
`IVisibilityTestable`	`getVisibilityTestable(Object forUserObject)` Returns an implementation of `IVisibilityTestable` that can determine if the rendering of the user object would be visible in a given context.
`IVisualCreator`	`getVisualCreator(Object forUserObject)` Returns an implementation of `IVisualCreator` that will create the `Node` tree for the user object.
`boolean`	`isCurrentCandidate()` Gets a property that determines whether this descriptor uses the "current" candidates.
`boolean`	`isDirty(ICanvasContext context, ICanvasObject canvasObject)` Determines whether the given canvas object is deemed dirty and needs updating.
`boolean`	`isHit(IInputModeContext context, PointD location)` Determines if something has been hit at the given coordinates in the world coordinate system.
`boolean`	`isInBox(IInputModeContext context, RectD rectangle)` This callback returns `true` if the corresponding item is considered to intersect the given rectangular box.
`boolean`	`isVisible(ICanvasContext context, RectD rectangle)` Determines whether an element might intersect the visible region for a given context.
`void`	`setCurrentCandidate(boolean value)` Sets a property that determines whether this descriptor uses the "current" candidates.
`void`	`setSize(double value)` Sets the logical size of the candidate.
`void`	`setTemplate(ResourceKey resourceKey, IVisualTemplate template)` Sets the `IVisualTemplate` to use for the given `ResourceKey` by this instance.
`Node`	`updateVisual(IRenderContext context, Node oldVisual)` This method updates or replaces a previously created `Node` for inclusion in the `IRenderContext`.

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

Methods inherited from interface com.yworks.yfiles.view.IBoundsProvider
fromRectangle

Methods inherited from interface com.yworks.yfiles.view.input.IHitTestable
create

- Field Detail
  - CANDIDATE_DRAWING_INVALID_FOCUSED_KEY
```
public static final ResourceKey CANDIDATE_DRAWING_INVALID_FOCUSED_KEY
```
    A ResourceKey that can be used by instances of the DefaultPortCandidateDescriptor to look up a IVisualTemplate that will be used for rendering a invalid, focused IPortCandidate.
    The drawing returned should be centered around (0,0).
  - CANDIDATE_DRAWING_INVALID_NON_FOCUSED_KEY
```
public static final ResourceKey CANDIDATE_DRAWING_INVALID_NON_FOCUSED_KEY
```
    A ResourceKey that can be used by instances of the DefaultPortCandidateDescriptor to look up a IVisualTemplate that will be used for rendering an invalid, non-focused IPortCandidate.
    The drawing returned should be centered around (0,0).
  - CANDIDATE_DRAWING_VALID_FOCUSED_KEY
```
public static final ResourceKey CANDIDATE_DRAWING_VALID_FOCUSED_KEY
```
    A ResourceKey that can be used by instances of the DefaultPortCandidateDescriptor to look up a IVisualTemplate that will be used for rendering a valid, focused IPortCandidate.
    The drawing returned should be centered around (0,0).
  - CANDIDATE_DRAWING_VALID_NON_FOCUSED_KEY
```
public static final ResourceKey CANDIDATE_DRAWING_VALID_NON_FOCUSED_KEY
```
    A ResourceKey that can be used by instances of the DefaultPortCandidateDescriptor to look up a IVisualTemplate that will be used for rendering a valid, non-focused IPortCandidate.
    The drawing returned should be centered around (0,0).
- Constructor Detail
  - DefaultPortCandidateDescriptor
```
public DefaultPortCandidateDescriptor()
```
    Instantiates a new descriptor.
- Method Detail
  - createVisual
```
public final Node createVisual(IRenderContext context)
```
    Description copied from interface: IVisualCreator
    
    This method is called by the framework to create a Node that will be included into the IRenderContext.
    CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.
    
    Specified by:
    
    createVisual in interface IVisualCreator
    
    Parameters:
    
    context - The context that describes where the visual will be used.
    
    Returns:
    
    The visual to include in the canvas object visual tree. This may be null.
    
    See Also:
    
    IVisualCreator.updateVisual(IRenderContext, Node)
  - getBounds
```
public final RectD getBounds(ICanvasContext context)
```
    Description copied from interface: IBoundsProvider
    
    Returns a tight rectangular area where the whole rendering would fit into.
    If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return RectD.INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or RectD.EMPTY.
    
    Specified by:
    
    getBounds in interface IBoundsProvider
    
    Parameters:
    
    context - the context to calculate the bounds for
    
    Returns:
    
    the bounds or RectD.EMPTY to indicate an unbound area
  - getBoundsProvider
```
public final IBoundsProvider getBoundsProvider(Object forUserObject)
```
    Description copied from interface: ICanvasObjectDescriptor
    
    Returns an implementation of IBoundsProvider that can determine the visible bounds of the rendering of the user object.
    This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
    
    Specified by:
    
    getBoundsProvider in interface ICanvasObjectDescriptor
    
    Parameters:
    
    forUserObject - the user object to query the bounds for
    
    Returns:
    
    an implementation or null if the bounds are not known, in which case the bounds are treated as infinite
  - getHitTestable
```
public final IHitTestable getHitTestable(Object forUserObject)
```
    Description copied from interface: ICanvasObjectDescriptor
    
    Returns an implementation of IHitTestable that can determine whether the rendering of the user object has been hit at a given coordinate.
    This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
    
    Specified by:
    
    getHitTestable in interface ICanvasObjectDescriptor
    
    Parameters:
    
    forUserObject - the user object to do the hit testing for
    
    Returns:
    
    an implementation or null if the rendering cannot be hit tested
  - getSize
```
public final double getSize()
```
    Gets the logical size of the candidate.
    This size is used for hit testing, visibility tests, etc. The default is 3.
    
    Returns:
    
    The Size.
    
    See Also:
    
    setSize(double)
  - getVisibilityTestable
```
public final IVisibilityTestable getVisibilityTestable(Object forUserObject)
```
    Description copied from interface: ICanvasObjectDescriptor
    
    Returns an implementation of IVisibilityTestable that can determine if the rendering of the user object would be visible in a given context.
    This method may always return the same instance. By contract clients will not cache instances returned but will always call this method before the methods on the instance will be called. This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
    
    Specified by:
    
    getVisibilityTestable in interface ICanvasObjectDescriptor
    
    Parameters:
    
    forUserObject - the user object to query the bounds for
    
    Returns:
    
    an implementation or null if the bounds are not known, in which case the bounds are treated as infinite
  - getVisualCreator
```
public final IVisualCreator getVisualCreator(Object forUserObject)
```
    Description copied from interface: ICanvasObjectDescriptor
    
    Returns an implementation of IVisualCreator that will create the Node tree for the user object.
    This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
    
    Specified by:
    
    getVisualCreator in interface ICanvasObjectDescriptor
    
    Parameters:
    
    forUserObject - the user object to create a Visual for
    
    Returns:
    
    an implementation or null if nothing shall be rendered
  - isCurrentCandidate
```
public final boolean isCurrentCandidate()
```
    Gets a property that determines whether this descriptor uses the "current" candidates.
    
    Returns:
    
    The CurrentCandidate.
    
    See Also:
    
    setCurrentCandidate(boolean)
  - isDirty
```
public final boolean isDirty(ICanvasContext context,
                             ICanvasObject canvasObject)
```
    Description copied from interface: ICanvasObjectDescriptor
    
    Determines whether the given canvas object is deemed dirty and needs updating.
    
    Specified by:
    
    isDirty in interface ICanvasObjectDescriptor
    
    Parameters:
    
    context - The context that will be used for the update.
    
    canvasObject - The object to check.
    
    Returns:
    
    Whether an update is needed.
  - isHit
```
public final boolean isHit(IInputModeContext context,
                           PointD location)
```
    Description copied from interface: IHitTestable
    
    Determines if something has been hit at the given coordinates in the world coordinate system.
    Implementations should inspect the HitTestRadius and take the value into account when performing hit tests. This allows the user to hit elements even if the zoom level is very small and allows for accurate hit tests at greater zoom levels.
    
    Specified by:
    
    isHit in interface IHitTestable
    
    Parameters:
    
    context - the context the hit test is performed in
    
    location - the coordinates in world coordinate system
    
    Returns:
    
    whether something has been hit
  - isInBox
```
public final boolean isInBox(IInputModeContext context,
                             RectD rectangle)
```
    Description copied from interface: IMarqueeTestable
    
    This callback returns true if the corresponding item is considered to intersect the given rectangular box.
    This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.
    
    Implementations should respect the HitTestRadius if marquee selections should behave differently on different zoom levels.
    
    Specified by:
    
    isInBox in interface IMarqueeTestable
    
    Parameters:
    
    context - the current input mode context
    
    rectangle - the box describing the marquee's bounds
    
    Returns:
    
    true if the item is considered to be captured by the marquee
  - isVisible
```
public final boolean isVisible(ICanvasContext context,
                               RectD rectangle)
```
    Description copied from interface: IVisibilityTestable
    
    Determines whether an element might intersect the visible region for a given context.
    Conservative implementations can always return true.
    
    Specified by:
    
    isVisible in interface IVisibilityTestable
    
    Parameters:
    
    context - The context to determine the visibility for.
    
    rectangle - The visible region clip.
    
    Returns:
    
    false if and only if it is safe not to paint the element because it would not affect the given clipping region.
  - setCurrentCandidate
```
public final void setCurrentCandidate(boolean value)
```
    Sets a property that determines whether this descriptor uses the "current" candidates.
    
    Parameters:
    
    value - The CurrentCandidate to set.
    
    See Also:
    
    isCurrentCandidate()
  - setSize
```
public final void setSize(double value)
```
    Sets the logical size of the candidate.
    This size is used for hit testing, visibility tests, etc. The default is 3.
    
    Parameters:
    
    value - The Size to set.
    
    See Also:
    
    getSize()
  - setTemplate
```
public final void setTemplate(ResourceKey resourceKey,
                              IVisualTemplate template)
```
    Sets the IVisualTemplate to use for the given ResourceKey by this instance.
    This method can be used to reconfigure the visualization for the various keys that are declared by this class.
    
    Parameters:
    
    resourceKey - The key to reconfigure. This is one of CANDIDATE_DRAWING_VALID_NON_FOCUSED_KEY, CANDIDATE_DRAWING_INVALID_NON_FOCUSED_KEY, CANDIDATE_DRAWING_INVALID_FOCUSED_KEY, CANDIDATE_DRAWING_VALID_FOCUSED_KEY.
    
    template - The template to use instead of the default.
  - updateVisual
```
public final Node updateVisual(IRenderContext context,
                               Node oldVisual)
```
    Description copied from interface: IVisualCreator
    
    This method updates or replaces a previously created Node for inclusion in the IRenderContext.
    The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.
    
    Specified by:
    
    updateVisual in interface IVisualCreator
    
    Parameters:
    
    context - The context that describes where the visual will be used in.
    
    oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.
    
    Returns:
    
    oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.
    
    See Also:
    
    IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl

Class DefaultPortCandidateDescriptor

Field Summary

Fields inherited from interface com.yworks.yfiles.view.ICanvasObjectDescriptor

Fields inherited from interface com.yworks.yfiles.view.IBoundsProvider

Fields inherited from interface com.yworks.yfiles.view.input.IHitTestable

Fields inherited from interface com.yworks.yfiles.view.IVisibilityTestable

Fields inherited from interface com.yworks.yfiles.view.input.IMarqueeTestable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.view.IBoundsProvider

Methods inherited from interface com.yworks.yfiles.view.input.IHitTestable

Field Detail

CANDIDATE_DRAWING_INVALID_FOCUSED_KEY

CANDIDATE_DRAWING_INVALID_NON_FOCUSED_KEY

CANDIDATE_DRAWING_VALID_FOCUSED_KEY

CANDIDATE_DRAWING_VALID_NON_FOCUSED_KEY

Constructor Detail

DefaultPortCandidateDescriptor

Method Detail

createVisual

getBounds

getBoundsProvider

getHitTestable

getSize

getVisibilityTestable

getVisualCreator

isCurrentCandidate

isDirty

isHit

isInBox

isVisible

setCurrentCandidate

setSize

setTemplate

updateVisual