## Uses of Interface
com.dlsc.flexgantt.model.gantt.IRelationship

- Packages that use IRelationship
  Package | Description
  --- | ---
  com.dlsc.flexgantt.command.layer | Contains layer-specific commands.
  com.dlsc.flexgantt.model.gantt | A model definition and default implementation for a Gantt chart model, which is basically an extension of a tree table model, which itself is an extension of a tree model.
  com.dlsc.flexgantt.model.scheduling | Contains supporting classes for basic scheduling operations and constraint resolutions.
  com.dlsc.flexgantt.policy.layer | Policies that will be used in the context of layers.
  com.dlsc.flexgantt.swing | Contains the Gantt chart components and various other user interface elements that can be used together with the Gantt chart.
  com.dlsc.flexgantt.swing.layer | The right-hand side of any Gantt chart is a layer container, which is responsible for managing the various layer types.
  com.dlsc.flexgantt.swing.layer.system | Contains the system layers for drawing the background, grid lines, popups, relationships, controls, spreadsheets, overviews, global events and activities.

- - ### Uses of IRelationship in com.dlsc.flexgantt.command.layer

    Methods in com.dlsc.flexgantt.command.layer that return IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `protected IRelationship` | DefaultCreateRelationshipCommand.`createRelationship(TimelineObjectPath sourcePath, TimelineObjectPath targetPath)` Creates the relationship object, which stores the source and the target path.
    `IRelationship` | DefaultDeleteRelationshipCommand.`getRelationship()` Returns the relationship that was deleted from the model.
    `IRelationship` | DefaultCreateRelationshipCommand.`getRelationship()` The relationship that was created by the command.

    Constructors in com.dlsc.flexgantt.command.layer with parameters of type IRelationship
    Constructor and Description
    `DefaultDeleteRelationshipCommand(IRelationship relationship, DefaultGanttChartModel model)` Constructs a new command for deleting a relationship from a Gantt chart model.

    Constructor parameters in com.dlsc.flexgantt.command.layer with type arguments of type IRelationship
    Constructor and Description
    `DefaultDeleteMultipleRelationshipsCommand(Collection<IRelationship> relationships, DefaultGanttChartModel model)` Deletes several relationships at the same time.

  - ### Uses of IRelationship in com.dlsc.flexgantt.model.gantt

    Classes in com.dlsc.flexgantt.model.gantt that implement IRelationship
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultRelationship<T>` The default implementation for relationships.

    Methods in com.dlsc.flexgantt.model.gantt that return types with arguments of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<IRelationship<S>>` | IGanttChartModel.`getRelationships()` Returns all relationships so that they can be visualized by the `RelationshipLayer`.
    `Collection<IRelationship>` | GanttChartModelEvent.`getRelationships()` Returns the relationships that were added to or removed from the model.
    `Iterator<IRelationship<S>>` | DefaultGanttChartModel.`getRelationships()`
    `Iterator<IRelationship<S>>` | IGanttChartModel.`getRelationships(S timelineObject)` Returns those relationships that have the given timeline object either as a source or as a target object.
    `Iterator<IRelationship<S>>` | DefaultGanttChartModel.`getRelationships(S obj)`

    Methods in com.dlsc.flexgantt.model.gantt with parameters of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultGanttChartModel.`addRelationship(IRelationship<S> relationship)` Adds a single relationship to the model.
    `void` | DefaultGanttChartModel.`removeRelationship(IRelationship relationship)` Removes a single relationship from the model.

    Method parameters in com.dlsc.flexgantt.model.gantt with type arguments of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultGanttChartModel.`addRelationships(Collection<IRelationship<S>> relationships)` Adds a collection of relationships to the model.
    `void` | DefaultGanttChartModel.`removeRelationships(Collection<IRelationship> rel)` Removes a collection of relationships from the model.
    `void` | DefaultGanttChartModel.`setRelationships(Collection<IRelationship<S>> relationships)` Sets all relationships at once.

    Constructor parameters in com.dlsc.flexgantt.model.gantt with type arguments of type IRelationship
    Constructor and Description
    `GanttChartModelEvent(IGanttChartModel model, GanttChartModelEvent.ID id, Collection<IRelationship> relationships)` Constructs a new model event.

  - ### Uses of IRelationship in com.dlsc.flexgantt.model.scheduling

    Subinterfaces of IRelationship in com.dlsc.flexgantt.model.scheduling
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IConstraint<T,S extends IGranularity>` A constraint is a specialization of a generic relationship between two timeline objects.

    Classes in com.dlsc.flexgantt.model.scheduling that implement IRelationship
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractConstraint<T,S extends IGranularity>` An abstract constraint superclass, which can be used by both built-in time granularities `SimpleGranularity` and `TimeGranularity`.
    `class` | `SimpleGranularityConstraint<T>` A constraint that can be used when the `SimpleGranularity` type is used in the dateline of the Gantt chart.
    `class` | `TimeGranularityConstraint<T>` A constraint that can be used when the `TimeGranularity` type is used in the dateline of the Gantt chart.

    Methods in com.dlsc.flexgantt.model.scheduling with parameters of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | DefaultModelValidator.`createViolationText(IRelationship rel)` Creates a text description of the violation of a relationship.

  - ### Uses of IRelationship in com.dlsc.flexgantt.policy.layer

    Methods in com.dlsc.flexgantt.policy.layer with parameters of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `String` | DefaultLabelPolicy.`getLabel(IRelationship relationship, IGanttChartModel model, LabelType type)`
    `String` | ILabelPolicy.`getLabel(IRelationship relationship, IGanttChartModel model, LabelType type)` Returns a label for the given relationship object (usually a summary of the relationship meaning).
    `Object` | IPopupPolicy.`getPopupTitleValue(IRelationship relationship, IGanttChartModel model)` Returns an object that can be utilized to provide a title for a popup for a relationship.
    `Object` | DefaultPopupPolicy.`getPopupTitleValue(IRelationship relationship, IGanttChartModel model)`
    `Object` | IPopupPolicy.`getPopupValue(IRelationship relationship, IGanttChartModel model, boolean extended)` Returns an object that can be utilized to provide some kind of popup for a relationship.
    `Object` | DefaultPopupPolicy.`getPopupValue(IRelationship relationship, IGanttChartModel model, boolean extended)`
    `boolean` | IRelationshipPolicy.`isDeletable(IRelationship relationship, IGanttChartModel model)` Determines whether the given relationship object is deletable.
    `boolean` | DefaultRelationshipPolicy.`isDeletable(IRelationship relationship, IGanttChartModel model)`
    `boolean` | ISelectionPolicy.`isSelectable(IRelationship relationship, IGanttChartModel model)` Returns TRUE if the given relationship can be selected by the user (or programmatically) or not.
    `boolean` | DefaultSelectionPolicy.`isSelectable(IRelationship relationship, IGanttChartModel model)`

    Method parameters in com.dlsc.flexgantt.policy.layer with type arguments of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `ICommand` | IRelationshipPolicy.`getDeleteRelationshipsCommand(Collection<IRelationship> relationships, IGanttChartModel model)` Returns a command object that will perform the actual deletion of several relationship objects from the given model.
    `ICommand` | DefaultRelationshipPolicy.`getDeleteRelationshipsCommand(Collection<IRelationship> relationships, IGanttChartModel model)`

  - ### Uses of IRelationship in com.dlsc.flexgantt.swing

    Methods in com.dlsc.flexgantt.swing that return IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `IRelationship` | RelationshipMessage.`getRelationship()`
    `IRelationship` | IRelationshipMessage.`getRelationship()` The relationship for which the message was generated.

    Constructors in com.dlsc.flexgantt.swing with parameters of type IRelationship
    Constructor and Description
    `RelationshipMessage(MessageTypeId id, String text, Date time, IRelationship relationship)` Constructs a new message.
    `RelationshipMessage(MessageTypeId id, String text, IRelationship relationship)` Constructs a new message.
    `RelationshipMessage(MessageTypeId id, String text, Object details, Date time, IRelationship relationship)` Constructs a new message.
    `RelationshipMessage(MessageTypeId id, String text, Object details, IRelationship relationship)` Constructs a new message.
    `RelationshipMessage(String text, IRelationship relationship)` Constructs a new information message.
    `RelationshipMessage(String text, Object details, IRelationship relationship)` Constructs a new error message.

  - ### Uses of IRelationship in com.dlsc.flexgantt.swing.layer

    Methods in com.dlsc.flexgantt.swing.layer with parameters of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `JPopupMenu` | DefaultLayerContainerMenuProvider.`getPopupMenu(LayerContainer lc, MouseEvent e, long timePoint, TreePath treePath, TimelineObjectPath[] paths, IRelationship[] relationships)`
    `JPopupMenu` | ILayerContainerMenuProvider.`getPopupMenu(LayerContainer lc, MouseEvent e, long timePoint, TreePath treePath, TimelineObjectPath[] paths, IRelationship[] relationships)` Returns a popup menu for the given layer container.

  - ### Uses of IRelationship in com.dlsc.flexgantt.swing.layer.system

    Methods in com.dlsc.flexgantt.swing.layer.system that return IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `IRelationship` | DefaultRelationshipRenderer.`getRelationship()` Returns the currently drawn relationship object.

    Methods in com.dlsc.flexgantt.swing.layer.system that return types with arguments of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `Map<Class<? extends IRelationship>,IRelationshipRenderer>` | RelationshipLayer.`getRelationshipRendererMap()` Returns the renderer map used by this layer.
    `Collection<IRelationship>` | RelationshipSelectionEvent.`getRelationships()` Returns the relationships that were added or removed to the selection model.
    `List<IRelationship>` | RelationshipLayer.`getRelationshipsAt(int x, int y)` Returns all relationships that can be found at the given coordinate.
    `Collection<IRelationship>` | RelationshipLayer.`getSelectedRelationships()` Returns all currently selected relationships.
    `Collection<IRelationship>` | DefaultRelationshipSelectionModel.`getSelection()`
    `Collection<IRelationship>` | IRelationshipSelectionModel.`getSelection()` Returns all relationship model object that are currently selected.

    Methods in com.dlsc.flexgantt.swing.layer.system with parameters of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `GeneralPath` | DefaultRelationshipRenderer.`drawRelationship(RelationshipLayer layer, Graphics g, IRelationship relationship, boolean focused, boolean selected)`
    `GeneralPath` | IRelationshipRenderer.`drawRelationship(RelationshipLayer layer, Graphics g, IRelationship relationship, boolean focused, boolean selected)` Draws a relationship between two timeline objects.
    `Component` | DefaultPopupRenderer.`getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, IRelationship relationship, IGanttChartModel model)`
    `Component` | AbstractPopupRenderer.`getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, IRelationship relationship, IGanttChartModel model)`
    `Component` | IPopupRenderer.`getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, IRelationship relationship, IGanttChartModel model)` Returns the component that will be used as a popup that provides additional information about a relationship.
    `protected Icon` | AbstractPopupRenderer.`getTitleIcon(Object popupValue, IRelationship relationship, IGanttChartModel model)` Returns an icon that will be shown in the header / title of the popup.
    `boolean` | DefaultRelationshipSelectionModel.`isSelected(IRelationship relationship)`
    `boolean` | IRelationshipSelectionModel.`isSelected(IRelationship relationship)` Returns TRUE if the given relationship object is selected.
    `protected void` | DefaultRelationshipRenderer.`paintArrowHead(Graphics g, IRelationship rel, int x, int y)` Draws an arrow at the end of the relationship line.
    `protected void` | RelationshipLayer.`paintRelationship(Graphics g, int w, int h, IRelationship relationship, IGanttChartModel model)` Paints the given relationship object.
    `protected void` | DefaultRelationshipRenderer.`paintRelationshipPath(Graphics g, IRelationship rel, GeneralPath path)` Performs the actual drawing of the relationship line based on the path that was calculated by the `DefaultRelationshipRenderer.drawRelationship(RelationshipLayer, Graphics, IRelationship, boolean, boolean)` method via the path calculator object.
    `protected void` | PopupLayer.`paintRelationshipPopup(Graphics g, IRelationship relationship)` Renders the popup for the given timeline object path.

    Method parameters in com.dlsc.flexgantt.swing.layer.system with type arguments of type IRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultRelationshipSelectionModel.`addSelection(Collection<IRelationship> relationships)`
    `void` | IRelationshipSelectionModel.`addSelection(Collection<IRelationship> relationships)` Adds several relationships to the selection.
    `void` | DefaultRelationshipSelectionModel.`removeSelection(Collection<IRelationship> relationships)`
    `void` | IRelationshipSelectionModel.`removeSelection(Collection<IRelationship> relationships)` Removes several relationships from the selection.
    `void` | RelationshipLayer.`setRelationshipRenderer(Class<? extends IRelationship> relationshipType, IRelationshipRenderer renderer)` Maps the implementation of a relationship renderer to a class definition.
    `void` | RelationshipLayer.`setRelationshipRendererMap(Map<Class<? extends IRelationship>,IRelationshipRenderer> map)` Sets the renderer map used by this layer.

    Constructor parameters in com.dlsc.flexgantt.swing.layer.system with type arguments of type IRelationship
    Constructor and Description
    `RelationshipSelectionEvent(IRelationshipSelectionModel model, RelationshipSelectionEvent.ID id, Collection<IRelationship> relationships)` Constructs a new selection event.

Copyright © 2006–2020 Dirk Lemmermann Software & Consulting. All rights reserved.