javax.swing.text: public class: IconView

javax.swing.text
public class: IconView [javadoc | source]

java.lang.Object
   javax.swing.text.View
      javax.swing.text.IconView

All Implemented Interfaces:
SwingConstants

Icon decorator that implements the view interface. The entire element is used to represent the icon. This acts as a gateway from the display-only View implementations to interactive lightweight icons (that is, it allows icons to be embedded into the View hierarchy. The parent of the icon is the container that is handed out by the associated view factory.

author: Timothy - Prinzing

Fields inherited from javax.swing.text.View:
BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, X_AXIS, Y_AXIS, sharedBiasReturn

Constructor:

Constructor:
public IconView(Element elem) { super(elem); AttributeSet attr = elem.getAttributes(); c = StyleConstants.getIcon(attr); } Creates a new icon view that represents an element. Parameters: `elem` - the element to create a view for

 public IconView(Element elem) {
        super(elem);
        AttributeSet attr = elem.getAttributes();
        c = StyleConstants.getIcon(attr);
}

Creates a new icon view that represents an element.

Parameters:

elem - the element to create a view for

Method from javax.swing.text.IconView Summary:
getAlignment, getPreferredSpan, modelToView, paint, viewToModel

Methods from javax.swing.text.View:
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods from javax.swing.text.View:

append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.swing.text.IconView Detail:
public float getAlignment(int axis) { switch (axis) { case View.Y_AXIS: return 1; default: return super.getAlignment(axis); } } Determines the desired alignment for this view along an axis. This is implemented to give the alignment to the bottom of the icon along the y axis, and the default along the x axis.
public float getPreferredSpan(int axis) { switch (axis) { case View.X_AXIS: return c.getIconWidth(); case View.Y_AXIS: return c.getIconHeight(); default: throw new IllegalArgumentException("Invalid axis: " + axis); } } Determines the preferred span for this view along an axis.
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 document model coordinate space to the coordinate space of the view mapped to it.
public void paint(Graphics g, Shape a) { Rectangle alloc = a.getBounds(); c.paintIcon(getContainer(), g, alloc.x, alloc.y); } Paints the icon. The real paint behavior occurs naturally from the association that the icon has with its parent container (the same container hosting this view), so this simply allows us to position the icon properly relative to the view. Since the coordinate system for the view is simply the parent containers, positioning the child icon is easy.
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.

Method from javax.swing.text.IconView Detail:

 public float getAlignment(int axis) {
        switch (axis) {
        case View.Y_AXIS:
            return 1;
        default:
            return super.getAlignment(axis);
        }
}

Determines the desired alignment for this view along an axis. This is implemented to give the alignment to the bottom of the icon along the y axis, and the default along the x axis.

 public float getPreferredSpan(int axis) {
        switch (axis) {
        case View.X_AXIS:
            return c.getIconWidth();
        case View.Y_AXIS:
            return c.getIconHeight();
        default:
            throw new IllegalArgumentException("Invalid axis: " + axis);
        }
}

Determines the preferred span for this view along an axis.

 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 document model coordinate space to the coordinate space of the view mapped to it.

 public  void paint(Graphics g,
    Shape a) {
        Rectangle alloc = a.getBounds();
        c.paintIcon(getContainer(), g, alloc.x, alloc.y);
}

Paints the icon. The real paint behavior occurs naturally from the association that the icon has with its parent container (the same container hosting this view), so this simply allows us to position the icon properly relative to the view. Since the coordinate system for the view is simply the parent containers, positioning the child icon is easy.

 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.