Component decorator that implements the view interface. The
entire element is used to represent the component. This acts
as a gateway from the display-only View implementations to
interactive lightweight components (ie it allows components
to be embedded into the View hierarchy).
The component is placed relative to the text baseline
according to the value returned by
Component.getAlignmentY
. For Swing components
this value can be conveniently set using the method
JComponent.setAlignmentY
. For example, setting
a value of 0.75
will cause 75 percent of the
component to be above the baseline, and 25 percent of the
component to be below the baseline.
This class is implemented to do the extra work necessary to
work properly in the presence of multiple threads (i.e. from
asynchronous notification of model changes for example) by
ensuring that all component access is done on the event thread.
The component used is determined by the return value of the
createComponent method. The default implementation of this
method is to return the component held as an attribute of
the element (by calling StyleConstants.getComponent). A
limitation of this behavior is that the component cannot
be used by more than one text component (i.e. with a shared
model). Subclasses can remove this constraint by implementing
the createComponent to actually create a component based upon
some kind of specification contained in the attributes. The
ObjectView class in the html package is an example of a
ComponentView implementation that supports multiple component
views of a shared model.
Method from javax.swing.text.ComponentView Detail: |
protected Component createComponent() {
AttributeSet attr = getElement().getAttributes();
Component comp = StyleConstants.getComponent(attr);
return comp;
}
Create the component that is associated with
this view. This will be called when it has
been determined that a new component is needed.
This would result from a call to setParent or
as a result of being notified that attributes
have changed. |
public float getAlignment(int axis) {
if (c != null) {
switch (axis) {
case View.X_AXIS:
return c.getAlignmentX();
case View.Y_AXIS:
return c.getAlignmentY();
}
}
return super.getAlignment(axis);
}
Determines the desired alignment for this view along an
axis. This is implemented to give the alignment of the
embedded component. |
public final Component getComponent() {
return createdC;
}
Fetch the component associated with the view. |
public float getMaximumSpan(int axis) {
if ((axis != X_AXIS) && (axis != Y_AXIS)) {
throw new IllegalArgumentException("Invalid axis: " + axis);
}
if (c != null) {
Dimension size = c.getMaximumSize();
if (axis == View.X_AXIS) {
return size.width;
} else {
return size.height;
}
}
return 0;
}
Determines the maximum span for this view along an
axis. This is implemented to return the value
returned by Component.getMaximumSize along the
axis of interest. |
public float getMinimumSpan(int axis) {
if ((axis != X_AXIS) && (axis != Y_AXIS)) {
throw new IllegalArgumentException("Invalid axis: " + axis);
}
if (c != null) {
Dimension size = c.getMinimumSize();
if (axis == View.X_AXIS) {
return size.width;
} else {
return size.height;
}
}
return 0;
}
Determines the minimum span for this view along an
axis. This is implemented to return the value
returned by Component.getMinimumSize along the
axis of interest. |
public float getPreferredSpan(int axis) {
if ((axis != X_AXIS) && (axis != Y_AXIS)) {
throw new IllegalArgumentException("Invalid axis: " + axis);
}
if (c != null) {
Dimension size = c.getPreferredSize();
if (axis == View.X_AXIS) {
return size.width;
} else {
return size.height;
}
}
return 0;
}
Determines the preferred span for this view along an
axis. This is implemented to return the value
returned by Component.getPreferredSize along the
axis of interest. |
public Shape modelToView(int pos,
Shape a,
Bias b) throws BadLocationException {
int p0 = getStartOffset();
int p1 = getEndOffset();
if ((pos >= p0) && (pos < = p1)) {
Rectangle r = a.getBounds();
if (pos == p1) {
r.x += r.width;
}
r.width = 0;
return r;
}
throw new BadLocationException(pos + " not in range " + p0 + "," + p1, pos);
}
Provides a mapping from the coordinate space of the model to
that of the view. |
public void paint(Graphics g,
Shape a) {
if (c != null) {
Rectangle alloc = (a instanceof Rectangle) ?
(Rectangle) a : a.getBounds();
c.setBounds(alloc.x, alloc.y, alloc.width, alloc.height);
}
}
The real paint behavior occurs naturally from the association
that the component has with its parent container (the same
container hosting this view). This is implemented to do nothing. |
void setComponentParent() {
View p = getParent();
if (p != null) {
Container parent = getContainer();
if (parent != null) {
if (c == null) {
// try to build a component
Component comp = createComponent();
if (comp != null) {
createdC = comp;
c = new Invalidator(comp);
}
}
if (c != null) {
if (c.getParent() == null) {
// components associated with the View tree are added
// to the hosting container with the View as a constraint.
parent.add(c, this);
parent.addPropertyChangeListener("enabled", c);
}
}
}
} else {
if (c != null) {
Container parent = c.getParent();
if (parent != null) {
// remove the component from its hosting container
parent.remove(c);
parent.removePropertyChangeListener("enabled", c);
}
}
}
}
Set the parent of the embedded component
with assurance that it is thread-safe. |
public void setParent(View p) {
super.setParent(p);
if (SwingUtilities.isEventDispatchThread()) {
setComponentParent();
} else {
Runnable callSetComponentParent = new Runnable() {
public void run() {
Document doc = getDocument();
try {
if (doc instanceof AbstractDocument) {
((AbstractDocument)doc).readLock();
}
setComponentParent();
Container host = getContainer();
if (host != null) {
preferenceChanged(null, true, true);
host.repaint();
}
} finally {
if (doc instanceof AbstractDocument) {
((AbstractDocument)doc).readUnlock();
}
}
}
};
SwingUtilities.invokeLater(callSetComponentParent);
}
}
Sets the parent for a child view.
The parent calls this on the child to tell it who its
parent is, giving the view access to things like
the hosting Container. The superclass behavior is
executed, followed by a call to createComponent if
the parent view parameter is non-null and a component
has not yet been created. The embedded components parent
is then set to the value returned by getContainer .
If the parent view parameter is null, this view is being
cleaned up, thus the component is removed from its parent.
The changing of the component hierarchy will
touch the component lock, which is the one thing
that is not safe from the View hierarchy. Therefore,
this functionality is executed immediately if on the
event thread, or is queued on the event queue if
called from another thread (notification of change
from an asynchronous update). |
public int viewToModel(float x,
float y,
Shape a,
Bias[] bias) {
Rectangle alloc = (Rectangle) a;
if (x < alloc.x + (alloc.width / 2)) {
bias[0] = Position.Bias.Forward;
return getStartOffset();
}
bias[0] = Position.Bias.Backward;
return getEndOffset();
}
Provides a mapping from the view coordinate space to the logical
coordinate space of the model. |