Class marimba.gui.RichTextBoxWidget
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class marimba.gui.RichTextBoxWidget

java.lang.Object
   |
   +----marimba.gui.Widget
           |
           +----marimba.gui.TextWidget
                   |
                   +----marimba.gui.RichTextBoxWidget

public class RichTextBoxWidget
extends TextWidget
A rich text widget.
Version:
1.39, 01/13/97
Author:
Jonathan Payne

Variable Index

 o fillScrollbar
The scrollbar can be made filled.
 o text
The text that is currently in the rich text box.
 o view
The textview that is used for rich text boxes.
 o vsbar
The vertical scrollbar that can be used in rich text boxes.

Constructor Index

 o RichTextBoxWidget()
Constructor

Method Index

 o append(char)
Append to the end of text.
 o append(String)
Append to the end of text.
 o appendStyle(String, int, Color)
 o clear()
Clear the text.
 o delete()
Clear the current selection.
 o disable(boolean)
Disable this text
 o eventInText(Event)
Checks whether the given event is within the text view.
 o focus(int)
Focus on a character position.
 o focusInterest()
This widget is not interested in the character focus.
 o getAlign()
Get the current align of the text.
 o getAlignOptions()
Get the align options.
 o getCaretColor()
Get the color of the caret.
 o getChildProperties(PropertyList)
Don't save the children of this container.
 o getEditor()
Get the editor.
 o getFillScrollbar()
Check whether the scrollbar is filled.
 o getInset()
Get the inset of the rich text box.
 o getLength()
Get the length of the text.
 o getProperties(PropertyList)
Get the properties of this widget.
 o getRichText()
 o getSavetext()
Check whether the text is being saved.
 o getScrollbar()
Get the vertical scrollbar.
 o getScrolling()
Check whether the text can scroll.
 o getSelected()
Get the selected part of the text.
 o getSelections()
Check whether the text can be selected.
 o getSelEnd()
Return the end of the selection.
 o getSelStart()
Return the start of the selection.
 o getShadowColor()
Get the shadow color.
 o getStyle()
Get the current style.
 o getStyleOptions()
Get the style options.
 o getText()
Get the value of the text.
 o getTextValue()
Get the Text object associated with this view.
 o getTextViewValue()
Get the TextView object associated with this widget.
 o getWrap()
Get the current wrap.
 o getWrapOptions()
Get the wrap options.
 o handleEvent(Event)
Forward events to the right widget during editing.
 o hasScrollbar()
Check whether the RichTextBox displays a scrollbar.
 o insert(char)
Insert a character.
 o insert(String)
Insert a string at the current cursor position.
 o invalidate()
Invalidate the widget (the size has changed).
 o layout()
Layout
 o newTextView()
 o preferredSize()
 o requestFocus()
Request focus
 o select(int, int)
Select a portion of the text.
 o select(int, int, int)
Select a portion of the text.
 o selectAll()
Select the entire text.
 o setAlign(int)
Set the alignment.
 o setCaretColor(Color)
Set the color of the caret.
 o setEditable(boolean)
Make this text editable.
 o setEditor(Object)
Set the editor.
 o setFillScrollbar(boolean)
Fill the scrollbar or not.
 o setForeground(Color)
Set the foreground color.
 o setInset(int)
Set the inset of the rich text box.
 o setProperties(PropertyList)
Set the properties of this widget.
 o setSavetext(boolean)
Let the text be saved or not.
 o setScrollbar(boolean)
Let the RichTextBox use a scrollbar or not.
 o setScrollbar(ScrollbarWidget)
Set the vertical scrollbar.
 o setScrolling(boolean)
Allow or forbid scrolling of the text.
 o setSelections(boolean)
Allow or forbid selections.
 o setShadowColor(Color)
Set the shadow color.
 o setStyle(int)
Set the style.
 o setText(String)
Sets the value for the text.
 o setWrap(int)
Set the wrap.

Variables

 o view
  public TextView view
The textview that is used for rich text boxes. The actual text processing is done by this textview.
 o text
  public Text text
The text that is currently in the rich text box.
 o vsbar
  public ScrollbarWidget vsbar
The vertical scrollbar that can be used in rich text boxes.
See Also:
hasScrollbar, getScrollbar, setScrollbar
 o fillScrollbar
  public boolean fillScrollbar
The scrollbar can be made filled.
See Also:
getFillScrollbar, setFillScrollbar

Constructors

 o RichTextBoxWidget
  public RichTextBoxWidget()
Constructor

Methods

 o getProperties
  public void getProperties(PropertyList list)
Get the properties of this widget.
Overrides:
getProperties in class TextWidget
 o getChildProperties
  public void getChildProperties(PropertyList list)
Don't save the children of this container.
Overrides:
getChildProperties in class Widget
 o setProperties
  public void setProperties(PropertyList list)
Set the properties of this widget.
Overrides:
setProperties in class TextWidget
 o getStyleOptions
  public Options getStyleOptions()
Get the style options.
 o getAlignOptions
  public Options getAlignOptions()
Get the align options.
 o getWrapOptions
  public Options getWrapOptions()
Get the wrap options.
 o getFillScrollbar
  public boolean getFillScrollbar()
Check whether the scrollbar is filled.
See Also:
fillScrollbar
 o setFillScrollbar
  public void setFillScrollbar(boolean fillScrollbar)
Fill the scrollbar or not.
See Also:
fillScrollbar
 o setForeground
  public void setForeground(Color c)
Set the foreground color.
Overrides:
setForeground in class Widget
 o getRichText
  public String getRichText()
 o newTextView
  public TextView newTextView()
 o preferredSize
  public Dimension preferredSize()
 o getEditor
  public String getEditor()
Get the editor.
Overrides:
getEditor in class Widget
 o setEditor
  public void setEditor(Object editor)
Set the editor.
Overrides:
setEditor in class Widget
 o getText
  public String getText()
Get the value of the text.
Overrides:
getText in class Widget
 o setText
  public void setText(String str)
Sets the value for the text.
Overrides:
setText in class Widget
 o getTextValue
  public Text getTextValue()
Get the Text object associated with this view.
 o getTextViewValue
  public TextView getTextViewValue()
Get the TextView object associated with this widget.
 o disable
  public void disable(boolean disabled)
Disable this text
Overrides:
disable in class Widget
 o setEditable
  public void setEditable(boolean editable)
Make this text editable.
Overrides:
setEditable in class TextWidget
 o hasScrollbar
  public boolean hasScrollbar()
Check whether the RichTextBox displays a scrollbar.
See Also:
vsbar
 o setScrollbar
  public void setScrollbar(boolean scrollbar)
Let the RichTextBox use a scrollbar or not.
See Also:
vsbar
 o getScrollbar
  public ScrollbarWidget getScrollbar()
Get the vertical scrollbar.
See Also:
vsbar
 o setScrollbar
  public void setScrollbar(ScrollbarWidget vsbar)
Set the vertical scrollbar.
See Also:
vsbar
 o getSavetext
  public boolean getSavetext()
Check whether the text is being saved.
See Also:
setSavetext
 o setSavetext
  public void setSavetext(boolean savetext)
Let the text be saved or not.
See Also:
setSavetext
 o getSelections
  public boolean getSelections()
Check whether the text can be selected.
 o setSelections
  public void setSelections(boolean selections)
Allow or forbid selections.
 o getScrolling
  public boolean getScrolling()
Check whether the text can scroll.
 o setScrolling
  public void setScrolling(boolean scrolling)
Allow or forbid scrolling of the text.
 o getInset
  public int getInset()
Get the inset of the rich text box.
 o setInset
  public void setInset(int inset)
Set the inset of the rich text box.
 o getCaretColor
  public Color getCaretColor()
Get the color of the caret.
 o setCaretColor
  public void setCaretColor(Color caretColor)
Set the color of the caret.
 o getShadowColor
  public Color getShadowColor()
Get the shadow color.
 o setShadowColor
  public void setShadowColor(Color shadowColor)
Set the shadow color.
 o getLength
  public int getLength()
Get the length of the text.
Overrides:
getLength in class TextWidget
 o getSelStart
  public int getSelStart()
Return the start of the selection.
Overrides:
getSelStart in class TextWidget
 o getSelEnd
  public int getSelEnd()
Return the end of the selection.
Overrides:
getSelEnd in class TextWidget
 o getSelected
  public String getSelected()
Get the selected part of the text.
Overrides:
getSelected in class TextWidget
 o clear
  public void clear()
Clear the text.
Overrides:
clear in class TextWidget
 o delete
  public void delete()
Clear the current selection.
Overrides:
delete in class TextWidget
 o insert
  public void insert(char ch)
Insert a character. This wil first clear the selecton, before inserting the character.
Overrides:
insert in class TextWidget
 o insert
  public void insert(String str)
Insert a string at the current cursor position.
Overrides:
insert in class TextWidget
 o append
  public void append(char ch)
Append to the end of text.
Overrides:
append in class TextWidget
 o append
  public void append(String str)
Append to the end of text.
Overrides:
append in class TextWidget
 o appendStyle
  public void appendStyle(String str,
                          int face,
                          Color c)
 o focusInterest
  public boolean focusInterest()
This widget is not interested in the character focus.
Overrides:
focusInterest in class TextWidget
 o selectAll
  public void selectAll()
Select the entire text.
Overrides:
selectAll in class TextWidget
 o select
  public void select(int selStart,
                     int selEnd)
Select a portion of the text.
Overrides:
select in class TextWidget
 o select
  public void select(int selStart,
                     int selEnd,
                     int depth)
Select a portion of the text. Depth controls character (1), word (2), and line selection (3).
Overrides:
select in class TextWidget
 o focus
  public void focus(int pos)
Focus on a character position.
Overrides:
focus in class TextWidget
 o layout
  public void layout()
Layout
Overrides:
layout in class Widget
 o invalidate
  public void invalidate()
Invalidate the widget (the size has changed).
Overrides:
invalidate in class Widget
 o getStyle
  public int getStyle()
Get the current style.
 o setStyle
  public void setStyle(int style)
Set the style.
 o getAlign
  public int getAlign()
Get the current align of the text.
 o setAlign
  public void setAlign(int align)
Set the alignment.
 o getWrap
  public int getWrap()
Get the current wrap. Returns a widgetConstant: CHAR, WORD, TRUNCATE.
 o setWrap
  public void setWrap(int wrap)
Set the wrap. Expects a widgetConstant: CHAR, WORD, TRUNCATE.
 o requestFocus
  public void requestFocus()
Request focus
Overrides:
requestFocus in class Widget
 o eventInText
  protected boolean eventInText(Event evt)
Checks whether the given event is within the text view.
Overrides:
eventInText in class TextWidget
 o handleEvent
  public boolean handleEvent(Event evt)
Forward events to the right widget during editing.
Overrides:
handleEvent in class TextWidget

All Packages  Class Hierarchy  This Package  Previous  Next  Index