DbSchema/com.wisecoders.dbs.schema/Layout

Layout

class Layout(val project: Project, name: String) : Diagram, AbstractLayout

Is a diagram plus the Relational Data Browse, SQL editors, Query Builders.

Constructors

constructor(project: Project, name: String)

Properties

open val _depicts: CopyOnWriteArrayList<Depict>

backgroundColor

var backgroundColor: Color?

val browses: Folder<ERROR CLASS: Symbol not found for Browse>

val callouts: List<Callout>

val canRedo: SimpleBooleanProperty

val canUndo: SimpleBooleanProperty

open override val children: List<Folder<*>>

open override var comment: String?

val commentNotNull: String

open override var commentTags: Map<String, String>

open override val depicts: List<Depict>

val entities: Set<Entity>

val freePlacePoint: Point

val groups: MutableList<Group>

var height: Double

hiddenRelationNames

val hiddenRelationNames: String?

var isChanged: Boolean

var isConfirmed: Boolean

isJoinedRouting

var isJoinedRouting: Boolean

val isJson: Boolean

isMarkedForDeletion

open override val isMarkedForDeletion: Boolean

var isShowDataType: Boolean

isShowDeducedFks

var isShowDeducedFks: Boolean

isShowPageBorders

var isShowPageBorders: Boolean

isShowPhysicalDictionaryName

var isShowPhysicalDictionaryName: Boolean

isShowPhysicalName

var isShowPhysicalName: Boolean

isShowSchemaName

var isShowSchemaName: Boolean

open override var isVirtual: Boolean

open var key: String

val layoutDepicts: Folder<Depict>

var lineTextType: LineTextType

mostReferredDepict

val mostReferredDepict: Depict?

open override var mutatedAt: Long

open override var name: String

open override val parent: TreeUnit?

var priorName: String?

val project: Project

val queries: Folder<ERROR CLASS: Symbol not found for Query>

val routing: DiagramRouting

val scripts: Folder<Script>

val shapes: List<Shape>

open override val symbolicName: String

open var syncFolders: List<List<AbstractUnit>>

var width: Double

This is the minimal surface rectangle which includes all layout entities.

Functions

fun attach(t: Entity, x: Double, y: Double): Depict

fun attach(entity: Entity): Depict

attachHierarchical

fun attachHierarchical(entity: Entity)

attachManyToManyGeneratedTables

fun attachManyToManyGeneratedTables()

attachRecursive

fun attachRecursive(entity: Entity?, where: Point, includeEmptyEntities: Boolean): MutableList<Depict>

attachRecursiveAndCreateGroupForHierarchicalEntities

fun attachRecursiveAndCreateGroupForHierarchicalEntities(entity: Entity, dropPoint: Point)

fun autoArrange(mode: ArrangerMode)

fun autoArrange()

open override fun autoArrange(group: Group)

autoArrangeKeepGroups

fun autoArrangeKeepGroups()

fun bringToFront(callout: Callout)

fun bringToFront(depict: Depict)

fun bringToFront(shape: Shape)

fun cloneLayout(layout: Layout, dx: Int, dy: Int, copyDiagramProperties: Boolean)

fun colorGroups(overrideTableColor: Boolean)

open operator override fun compareTo(other: AbstractUnit): Int

containsDepictFor

fun containsDepictFor(entity: TreeUnit?): Boolean

containsDepictForEntity

fun containsDepictForEntity(entity: Entity): Boolean

fun createBrowse(name: String?): ERROR CLASS: Symbol not found for Browse

fun createCallout(owner: TreeUnit?, position: Point): Callout

Create a callout for this unit. The unit or its entity has to be already in layout. Otherwise, returns null.

fun createCallout(text: String, position: Point): Callout

fun createGroup(name: String): Group

fun createQuery(name: String?): ERROR CLASS: Symbol not found for Query

fun createScript(name: String?): Script

fun createShape(text: String?, position: Point): Shape

fun detach(depict: Depict): Boolean

fun detachUndoable(depict: Depict): Depict?

generateHtmlDocumentation

fun generateHtmlDocumentation(expose: Expose)

fun generateHtmlDocumentation(file: File)

fun generateHtmlDocumentation(file: File, layouts: List<Layout>)

Generate HTML documentation. Can be called from Groovy code

generateMarkdownDocumentation

fun generateMarkdownDocumentation(expose: Expose)

fun generateMarkdownDocumentation(file: File, layouts: List<Layout>)

Generate Markdown documentation. Can be called from Groovy code.

generatePdfDocumentation

fun generatePdfDocumentation(expose: Expose)

fun generatePdfDocumentation(file: File)

fun generatePdfDocumentation(file: File, layouts: List<Layout>)

Generate PDF documentation. Can be called from Groovy code.

open override fun getByName(name: String): TreeUnit?

fun getCalloutFor(owner: TreeUnit?): Callout?

fun getDepictFor(unit: TreeUnit?): Depict?

getDepictIncludingShapeFor

fun getDepictIncludingShapeFor(unit: TreeUnit?): Depictable?

open override fun getDisplayName(diagram: Diagram): String

fun getGroup(name: String): Group?

open override fun getIcon(): ERROR CLASS: Symbol not found for Icon

fun getMarker(attr: Attribute): Int

getPropertyAddOnFolder

fun getPropertyAddOnFolder(name: String?): PropertyAddOnFolder?

getTargetTerminatorCardinality

fun getTargetTerminatorCardinality(notation: ERROR CLASS: Symbol not found for Notation, relation: Relation): RelationCardinality

fun hasMarker(attr: Attribute, marker: Int): Boolean

fun hideAllColumns()

hideColumnsOnLargeDepicts

fun hideColumnsOnLargeDepicts()

hideFunctionalColumns

fun hideFunctionalColumns()

fun hideRelation(rel: Relation?)

isRelationHidden

fun isRelationHidden(rel: Relation?): Boolean

markForDeletion

open override fun markForDeletion()

Call this method to mark a unit (table, column) to be deleted. It can be called from any thread. The effective deletion is done by calling project.refresh() or schema.refresh() on JavaFX GUI thread.

fun matches(unit: AbstractUnit?): Boolean

fun moveUndoable(depict: Depictable, toX: Double, toY: Double): Depictable?

fun redo()

open override fun ref(): String

fun refresh(forAutoGrouping: Boolean)

open override fun refresh()

Calculates new size

fun refreshFlags()

fun rename(newName: String): Boolean

fun resetChanged()

fun sameAs(unit: AbstractUnit): Boolean

open fun sameAs(unit: AbstractUnit, considerRenaming: Boolean): Boolean

open override fun setCommentTag(key: String, value: String?)

setDefaultLineText

fun setDefaultLineText(lineTextType: LineTextType)

setHideRelations

fun setHideRelations(hideRelationNames: String?)

fun setMarker(attr: Attribute, marker: Int)

fun setStoreId(id: String?)

fun showAllColumns()

showAllEntityForeignKeys

fun showAllEntityForeignKeys(entity: Entity?)

showAllForeignKeys

fun showAllForeignKeys()

open override fun toString(): String

fun undo()