| java.lang.Object
 javax.swing.text.View
org.netbeans.editor.BaseView
All known Subclasses: org.netbeans.editor.LeafView,
| BaseView | | abstract public class BaseView extends View (Code) | | Base abstract view serves as parent for both leaf and branch views.
author:
Miloslav Metelka
version:
1.00 |
| Field Summary | |
| final protected static int | INSETS_BOTTOM
Bottom insets paint type. | | final protected static int | INSETS_TOP
Top insets paint type. | | final protected static int | MAIN_AREA
Main area paint type. | | protected int | helperInd
Index of this view as child view in its parent. | | protected Insets | insets
Border insets of this view. | | protected boolean | packed
|
| Method Summary | |
| public void | displayHierarchy()
Display view hierarchy on console. | | public float | getAlignment(int axis)
| | abstract protected int | getBaseX(int y)
| | public JTextComponent | getComponent()
Get component hosting this view. | | protected EditorUI | getEditorUI()
| | abstract public int | getHeight()
| | public Insets | getInsets()
Get insets of this view. | | abstract protected int | getPaintAreas(Graphics g, int clipY, int clipHeight)
Returns binary composition of regions that should be painted. | | abstract protected int | getPosFromY(int y)
| | public float | getPreferredSpan(int axis)
| | protected int | getStartY()
Get y base value for this view. | | abstract protected int | getViewStartY(BaseView view, int helperInd)
Get child view's y base value. | | abstract protected int | getYFromPos(int pos)
| | protected void | invalidateStartY()
Informs the view that if it had cached start y of itself it should
invalidate it as it is no longer valid and it should call getViewStartY()
to get updated value. | | public boolean | isPacked()
| | abstract public void | modelToViewDG(int pos, DrawGraphics dg)
| | public void | paint(Graphics g, Shape allocation)
It divides painting into three areas: INSETS_TOP, MAIN_AREA,
INSETS_BOTTOM. | | abstract protected void | paintAreas(Graphics g, int clipY, int clipHeight, int paintAreas)
Paint either top insets, main area, or bottom insets. | | protected void | setHelperInd(int ind)
This function is used to correct information about which index this child
view occupies in parent view's array of children. | | public void | setPacked(boolean packed)
| | public String | toString()
| | abstract public void | updateMainHeight()
Update height of main area as result of some important change. |
| INSETS_BOTTOM | | final protected static int INSETS_BOTTOM(Code) | | Bottom insets paint type.
|
| INSETS_TOP | | final protected static int INSETS_TOP(Code) | | Top insets paint type.
|
| MAIN_AREA | | final protected static int MAIN_AREA(Code) | | Main area paint type.
|
| helperInd | | protected int helperInd(Code) | | Index of this view as child view in its parent. This gives the parent
view a hint at which index it should search for this view. If this index
is incorrect, the parent view searches the whole array of children.
However this gives good optimization of child views search process.
|
| insets | | protected Insets insets(Code) | | Border insets of this view. Can be null
|
| packed | | protected boolean packed(Code) | | Is this view packed
|
| BaseView | | public BaseView(Element elem)(Code) | | Construct new base view
|
| displayHierarchy | | public void displayHierarchy()(Code) | | Display view hierarchy on console. Current view is marked with asterisk.
|
| getAlignment | | public float getAlignment(int axis)(Code) | | Get aligment along an X_AXIS or Y_AXIS
|
| getBaseX | | abstract protected int getBaseX(int y)(Code) | | |
| getHeight | | abstract public int getHeight()(Code) | | Get height of the view
|
| getInsets | | public Insets getInsets()(Code) | | Get insets of this view.
|
| getPaintAreas | | abstract protected int getPaintAreas(Graphics g, int clipY, int clipHeight)(Code) | | Returns binary composition of regions that should be painted. It can be
binary composition of INSETS_TOP, MAIN_AREA and INSETS_BOTTOM.
Parameters:
g - Graphics to paint through
Parameters:
clip - clipping area of graphics object |
| getPosFromY | | abstract protected int getPosFromY(int y)(Code) | | Get position when knowing y-coord
|
| getPreferredSpan | | public float getPreferredSpan(int axis)(Code) | | Get preferred span over axis
|
| getStartY | | protected int getStartY()(Code) | | Get y base value for this view.
|
| getViewStartY | | abstract protected int getViewStartY(BaseView view, int helperInd)(Code) | | Get child view's y base value. This function is called by children of
this view to get its y offset.
Parameters:
view - is child view of this view for which the offset should becomputed.
Parameters:
helperInd - is index that child view has cached to ease the parent view tosearch for it in its children array. If this index is correct,parent uses it. If it's incorrect parent view searches throughthe whole array of its children to find the child. It thencalls children's setParentInd() to correct itslocation index. |
| invalidateStartY | | protected void invalidateStartY()(Code) | | Informs the view that if it had cached start y of itself it should
invalidate it as it is no longer valid and it should call getViewStartY()
to get updated value.
|
| isPacked | | public boolean isPacked()(Code) | | Getter for packed flag
|
| paint | | public void paint(Graphics g, Shape allocation)(Code) | | It divides painting into three areas: INSETS_TOP, MAIN_AREA,
INSETS_BOTTOM. It paints them sequentially using paintArea()
method until it returns false. This implementation also supposes that
allocation is instance of Rectangle to save
object creations. The root view in TextUI implementation will take care
to ensure child views will get rectangle instances.
|
| paintAreas | | abstract protected void paintAreas(Graphics g, int clipY, int clipHeight, int paintAreas)(Code) | | Paint either top insets, main area, or bottom insets.
Parameters:
g - Graphics to paint through
Parameters:
clip - clipping area of graphics object
Parameters:
paintAreas - binary composition of paint areas |
| setHelperInd | | protected void setHelperInd(int ind)(Code) | | This function is used to correct information about which index this child
view occupies in parent view's array of children. It is called by parent
view.
|
| setPacked | | public void setPacked(boolean packed)(Code) | | Setter for packed flag
|
| updateMainHeight | | abstract public void updateMainHeight()(Code) | | Update height of main area as result of some important change. Propagate
to child views if necessary.
|
| Methods inherited from javax.swing.text.View | public void append(View v)(Code)(Java Doc)
public View breakView(int axis, int offset, float pos, float len)(Code)(Java Doc)
public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public View createFragment(int p0, int p1)(Code)(Java Doc)
protected void forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
protected void forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public float getAlignment(int axis)(Code)(Java Doc)
public AttributeSet getAttributes()(Code)(Java Doc)
public int getBreakWeight(int axis, float pos, float len)(Code)(Java Doc)
public Shape getChildAllocation(int index, Shape a)(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public Document getDocument()(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
public int getEndOffset()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public float getMaximumSpan(int axis)(Code)(Java Doc)
public float getMinimumSpan(int axis)(Code)(Java Doc)
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
public View getParent()(Code)(Java Doc)
abstract public float getPreferredSpan(int axis)(Code)(Java Doc)
public int getResizeWeight(int axis)(Code)(Java Doc)
public int getStartOffset()(Code)(Java Doc)
public String getToolTipText(float x, float y, Shape allocation)(Code)(Java Doc)
public View getView(int n)(Code)(Java Doc)
public int getViewCount()(Code)(Java Doc)
public ViewFactory getViewFactory()(Code)(Java Doc)
public int getViewIndex(int pos, Position.Bias b)(Code)(Java Doc)
public int getViewIndex(float x, float y, Shape allocation)(Code)(Java Doc)
public void insert(int offs, View v)(Code)(Java Doc)
public void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
abstract public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int pos, Shape a) throws BadLocationException(Code)(Java Doc)
abstract public void paint(Graphics g, Shape allocation)(Code)(Java Doc)
public void preferenceChanged(View child, boolean width, boolean height)(Code)(Java Doc)
public void remove(int i)(Code)(Java Doc)
public void removeAll()(Code)(Java Doc)
public void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public void replace(int offset, int length, View[] views)(Code)(Java Doc)
public void setParent(View parent)(Code)(Java Doc)
public void setSize(float width, float height)(Code)(Java Doc)
protected boolean updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f)(Code)(Java Doc)
protected void updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a)(Code)(Java Doc)
abstract public int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)(Code)(Java Doc)
public int viewToModel(float x, float y, Shape a)(Code)(Java Doc)
|
|
|