VR
- The visual root node of the UI toolkit this IContentPart
is used in, e.g. javafx.scene.Node in case of JavaFX.V
- The visual node used by this IContentPart
.public interface IContentPart<VR,V extends VR> extends IVisualPart<VR,V>
IVisualPart
that visualizes an underlying content element.AbstractContentPart
should be sub-classed.Type | Property and Description |
---|---|
ReadOnlySetMultimapProperty<java.lang.Object,java.lang.String> |
contentAnchoragesUnmodifiable
Returns an unmodifiable read-only set-multimap property containing the
content anchorages.
|
javafx.beans.property.ReadOnlyListProperty<java.lang.Object> |
contentChildrenUnmodifiable
Returns an unmodfiable read-only property containing the content
children.
|
javafx.beans.property.ObjectProperty<java.lang.Object> |
content
A writable property representing the
IContentPart 's content. |
anchoragesUnmodifiable, anchoredsUnmodifiable, children, parent, refreshVisual
adapters
active
IAdaptable.Bound<A extends IAdaptable>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONTENT_ANCHORAGES_PROPERTY
Name of the
contentAnchoragesUnmodifiableProperty() . |
static java.lang.String |
CONTENT_CHILDREN_PROPERTY
Name of the
contentChildrenUnmodifiableProperty() . |
static java.lang.String |
CONTENT_PROPERTY
Name of the
content property . |
ANCHORAGES_PROPERTY, ANCHOREDS_PROPERTY, CHILDREN_PROPERTY, PARENT_PROPERTY, REFRESH_VISUAL_PROPERTY
ADAPTERS_PROPERTY
ACTIVE_PROPERTY
Modifier and Type | Method and Description |
---|---|
void |
addContentChild(java.lang.Object contentChild,
int index)
Inserts the given contentChild as a child to this part's content,
so that it will be returned by subsequent calls to
getContentChildrenUnmodifiable() . |
void |
attachToContentAnchorage(java.lang.Object contentAnchorage,
java.lang.String role)
Attaches this part's content to the given contentAnchorage under
the specified role, so that it will be returned by subsequent
calls to
getContentAnchoragesUnmodifiable() . |
ReadOnlySetMultimapProperty<java.lang.Object,java.lang.String> |
contentAnchoragesUnmodifiableProperty()
Returns an unmodifiable read-only set-multimap property containing the
content anchorages.
|
javafx.beans.property.ReadOnlyListProperty<java.lang.Object> |
contentChildrenUnmodifiableProperty()
Returns an unmodfiable read-only property containing the content
children.
|
javafx.beans.property.ObjectProperty<java.lang.Object> |
contentProperty()
A writable property representing the
IContentPart 's content. |
void |
detachFromContentAnchorage(java.lang.Object contentAnchorage,
java.lang.String role)
Detaches this part's content from the given contentAnchorage under
the specified role, so that it will no longer be returned by
subsequent calls to
getContentAnchoragesUnmodifiable() . |
java.lang.Object |
getContent()
Returns this part's content.
|
ObservableSetMultimap<java.lang.Object,java.lang.String> |
getContentAnchoragesUnmodifiable()
Returns an unmodifiable
ObservableSetMultimap that contains the
content objects that are to be regarded as anchorages of this
IContentPart 's content (getContent() ) with an (optional)
role qualifier for each anchorage-anchored link that has to be
established. |
javafx.collections.ObservableList<java.lang.Object> |
getContentChildrenUnmodifiable()
Returns an unmodifiable
ObservableList that contains the content
children. |
boolean |
isFocusable()
Returns
true if policies and other parts of the application
are allowed to assign focus to this part by changing the
FocusModel . |
boolean |
isSelectable()
Returns
true if policies and other parts of the application
are allowed to add this part to the selection maintained by the
SelectionModel . |
void |
refreshContentAnchorages()
Triggers a re-computation of the content anchorages of this
IContentPart . |
void |
refreshContentChildren()
Triggers a re-computation of the content children of this
IContentPart . |
void |
removeContentChild(java.lang.Object contentChild)
Removes the given contentChild from this part's content children,
so that it will no longer be returned by subsequent calls to
getContentChildrenUnmodifiable() . |
void |
reorderContentChild(java.lang.Object contentChild,
int newIndex)
Rearranges the given contentChild to the new index position.
|
void |
setContent(java.lang.Object content)
Sets this part's content to the given
value . |
addChild, addChild, addChildren, addChildren, anchoragesUnmodifiableProperty, anchoredsUnmodifiableProperty, attachAnchored, attachToAnchorage, attachToAnchorage, childrenProperty, detachAnchored, detachFromAnchorage, detachFromAnchorage, getAnchoragesUnmodifiable, getAnchoredsUnmodifiable, getBehaviors, getChildrenUnmodifiable, getParent, getPolicies, getRoot, getVisual, isRefreshVisual, parentProperty, refreshVisual, refreshVisualProperty, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual
adaptersProperty, getAdapter, getAdapter, getAdapter, getAdapterKey, getAdapters, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, setAdapter, unsetAdapter
activate, activeProperty, deactivate, isActive
dispose
ReadOnlySetMultimapProperty<java.lang.Object,java.lang.String> contentAnchoragesUnmodifiableProperty
getContentAnchoragesUnmodifiable()
javafx.beans.property.ReadOnlyListProperty<java.lang.Object> contentChildrenUnmodifiableProperty
getContentChildrenUnmodifiable()
javafx.beans.property.ObjectProperty<java.lang.Object> contentProperty
IContentPart
's content.getContent()
,
setContent(Object)
static final java.lang.String CONTENT_PROPERTY
content property
.static final java.lang.String CONTENT_CHILDREN_PROPERTY
contentChildrenUnmodifiableProperty()
.static final java.lang.String CONTENT_ANCHORAGES_PROPERTY
contentAnchoragesUnmodifiableProperty()
.void addContentChild(java.lang.Object contentChild, int index)
getContentChildrenUnmodifiable()
.contentChild
- An Object
which should be added as a child to this
part's content.index
- The index at which the contentChild should be added.void attachToContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role)
getContentAnchoragesUnmodifiable()
.contentAnchorage
- An Object
to which this part's content should be
attached to.role
- The role under which the attachment is to be established.ReadOnlySetMultimapProperty<java.lang.Object,java.lang.String> contentAnchoragesUnmodifiableProperty()
getContentAnchoragesUnmodifiable()
javafx.beans.property.ReadOnlyListProperty<java.lang.Object> contentChildrenUnmodifiableProperty()
getContentChildrenUnmodifiable()
javafx.beans.property.ObjectProperty<java.lang.Object> contentProperty()
IContentPart
's content.getContent()
,
setContent(Object)
void detachFromContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role)
getContentAnchoragesUnmodifiable()
.contentAnchorage
- An Object
from which this part's content should be
detached from.role
- The role under which the attachment is established.java.lang.Object getContent()
ObservableSetMultimap<java.lang.Object,java.lang.String> getContentAnchoragesUnmodifiable()
ObservableSetMultimap
that contains the
content objects that are to be regarded as anchorages of this
IContentPart
's content (getContent()
) with an (optional)
role qualifier for each anchorage-anchored link that has to be
established.
In case of a connection, one anchorage could have the "START" role, and another the "END" role. Using the role mechanism, the same anchorage may also have both roles, which can, for instance, be used for self connections.
ObservableSetMultimap
of the content
anchorages with a role to qualify each anchorage-anchored link.
If there is only a single anchorage-anchored link to a respective
anchorage, its role may be left undefined (i.e. the map will
contain an entry of the form (anchorage, null
)).javafx.collections.ObservableList<java.lang.Object> getContentChildrenUnmodifiable()
ObservableList
that contains the content
children.List
of all of this part's content children.boolean isFocusable()
true
if policies and other parts of the application
are allowed to assign focus to this part by changing the
FocusModel
. Otherwise returns false
.true
if policies and other parts of the application
are allowed to assign focus to this part by changing the
FocusModel
, otherwise false
.boolean isSelectable()
true
if policies and other parts of the application
are allowed to add this part to the selection maintained by the
SelectionModel
. Otherwise returns false
.true
if policies and other parts of the application
are allowed to add this part to the selection maintained by the
SelectionModel
, otherwise false
.void refreshContentAnchorages()
IContentPart
.void refreshContentChildren()
IContentPart
.void removeContentChild(java.lang.Object contentChild)
getContentChildrenUnmodifiable()
.contentChild
- An Object
which should be removed from this part's
content children.void reorderContentChild(java.lang.Object contentChild, int newIndex)
CONTENT_CHILDREN_PROPERTY
as
property name
.contentChild
- The Object
which is to be reordered.newIndex
- The index to which the content child is to be reordered.void setContent(java.lang.Object content)
value
. Fires
property change events using CONTENT_PROPERTY
as property name.content
- The new content for this part.Copyright (c) 2014 itemis AG and others. All rights reserved.