概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## com.change_vision.jude.api.inf.model
インタフェース IDiagram

    com.change_vision.jude.api.inf.model.IDiagram

すべてのスーパーインタフェース:
  IElement, IEntity, IHyperlinkOwner, INamedElement

すべての実装されたインタフェース:
  IElement, IEntity, IHyperlinkOwner, INamedElement

既知の実装クラスの一覧:
  IActivityDiagram, IClassDiagram, ICommunicationDiagram, ICompositeStructureDiagram, IDataFlowDiagram, IERDiagram, IMatrixDiagram, IMindMapDiagram, IRequirementDiagram, IRequirementTable, ISequenceDiagram, IStateMachineDiagram, ITraceabilityMap, IUseCaseDiagram

    public IDiagram

extends INamedElement

図に対するインターフェース。

フィールドの概要

クラス com.change_vision.jude.api.inf.model.INamedElement から継承されたフィールド
`PACKAGE_VISIBILITY, PRIVATE_VISIBILITY, PROTECTED_VISIBILITY, PUBLIC_VISIBILITY`

メソッドの概要
`abstract String` | `exportImage(String outputDir, String format, double dpi)` 図の画像をファイルに出力します。
`abstract Rectangle2D` | `getBoundRect()` 図の境界領域を表す矩形を返します.
`abstract IPresentation[]` | `getPresentations()` 図に配置されたプレゼンテーションまたはCRUDの各セル(値のセルおよびヘッダーセル)を取得します。
`abstract HashMap` | `getProperties()` プロパティを取得します。
`abstract String` | `getProperty(String key)` プロパティの値を取得します。
`abstract String[]` | `getText()` 推奨されていません。 図に配置されたテキストを取得します。
`abstract void` | `setProperties(Map map)` プロパティを設定します。
`abstract void` | `setProperty(String key, String value)` プロパティを設定します。

クラス com.change_vision.jude.api.inf.model.INamedElement から継承されたメソッド
`getAlias1, getAlias2, getClientDependencies, getClientRealizations, getClientUsages, getConstraints, getDefinition, getDiagrams, getName, getSupplierDependencies, getSupplierRealizations, getSupplierUsages, isPackageVisibility, isPrivateVisibility, isProtectedVisibility, isPublicVisibility, setAlias1, setAlias2, setDefinition, setName, setVisibility`

クラス com.change_vision.jude.api.inf.model.IElement から継承されたメソッド
`addStereotype, getComments, getContainer, getContainers, getId, getOwner, getPresentations, getStereotypes, getTaggedValues, getTypeModifier, isReadOnly, removeStereotype, setTypeModifier`

クラス com.change_vision.jude.api.inf.model.IHyperlinkOwner から継承されたメソッド
`createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks`

メソッドの詳細

### getText

    abstract String[] getText()

  推奨されていません。 図に配置されたテキストを取得します。

  戻り値:
    テキストの配列。ない場合、長さ0の配列を返します。

### getPresentations

    abstract IPresentation[] getPresentations()

  図に配置されたプレゼンテーションまたはCRUDの各セル(値のセルおよびヘッダーセル)を取得します。

  戻り値:
    プレゼンテーションの配列またはCRUDの各セル(値のセルおよびヘッダーセル)の配列。ない場合、長さ0の配列を返します。
  例外:
    `InvalidUsingException` - 例外が発生した場合

        Keys:
              ILLEGAL_USE_ERROR_KEY - astah* communityでプレゼンテーションAPIを使用しようとした場合
         Values:
              例外のエラーメッセージ

### getProperties

    abstract HashMap getProperties()

  プロパティを取得します。

  戻り値:
    プロパティ

### getProperty

    abstract String getProperty(String key)

  プロパティの値を取得します。

  パラメータ:
    `key` - プロパティのキー
  戻り値:
    プロパティの値

### setProperty

    abstract void setProperty(String key,
                              String value)

  プロパティを設定します。

  パラメータ:
    `key` - プロパティのキー value プロパティの値
  例外:
    `InvalidEditingException` - 例外が発生した場合

        Keys:
              ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合
              PARAMETER_ERROR_KEY - パラメータが正しく設定されていない場合
              BAD_TRANSACTION_KEY - トランザクションエラー
              HAS_EXCEPTION_KEY - 例外が発生した場合
              READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合

        Values:
              例外のエラーメッセージ

### setProperties

    abstract void setProperties(Map map)

  プロパティを設定します。

  パラメータ:
    `map` - プロパティ
  例外:
    `InvalidEditingException` - 例外が発生した場合

        Keys:
              ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合
              PARAMETER_ERROR_KEY - パラメータが正しく設定されていない場合
              BAD_TRANSACTION_KEY - トランザクションエラー
              HAS_EXCEPTION_KEY - 例外が発生した場合
              READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合

        Values:
              例外のエラーメッセージ

### getBoundRect

    abstract Rectangle2D getBoundRect()

  図の境界領域を表す矩形を返します. 座標が関係しない図については、空の矩形を返します. 矩形は、図に含まれる全図要素の境界領域を足し合わせて計算され、最後に余白が足されます. その余白は、上下左右に10の幅で付加されます.

  戻り値:
    図の境界矩形. nullを返すことはありません. 図要素が一つもない場合は、原点の周りに余白分を含めた領域を返します.

### exportImage

    abstract String exportImage(String outputDir,
                                String format,
                                double dpi)

  図の画像をファイルに出力します。 このAPIは、プラグイン（未提供）から呼び出された場合のみ動作します。

  パラメータ:
    `outputDir` - 出力するディレクトリ
    `format` - 画像のフォーマット. "png", "jpg", "emf"のいずれか
    `dpi` - 画像の解像度。無効な範囲の値を指定した場合は、デフォルトの96dpiで出力します。
  戻り値:
    作成した画像ファイルの場所。outputDirからの相対パスでファイル名を含みます。
  例外:
    `InvalidUsingException` - プラグイン以外から呼び出された場合など、画像出力に失敗した場合
    `InvalidExportImageException` - 例外が発生した場合
  関連項目:
    `IDiagram#getBoundRect()`

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド