Package com.iizix.prop.ui

Class UITextArea

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.ui.UIComp
com.iizix.prop.ui.UIText
com.iizix.prop.ui.UITextArea
All Implemented Interfaces:
EventListener, IFocusComp, IMessageBox, IComponent, ICustomDataProvider, IGProp<GProp<?>[]>, IPropCnr, IUIComp, IUICompRelativeTarget, IUIContextMenuOwner, IUIFocusComp, IUIHint, IUILabelForTarget, IUIPlainTextComponent, IUITextComponent, IVSComponentListener, IVSComponentState, IVSFieldListener, Cloneable
Direct Known Subclasses:
EUITextArea
public class UITextArea extends UIText
Text area UI component.
Author:
Christopher Mindus

  • Constructor Details

    • UITextArea

      public UITextArea()
      Creates the component without a name. The name must be set in all cases using the setPropertyAtom call.

    • UITextArea

      public UITextArea(Atom propertyAtom)
      Creates the component with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.

    • UITextArea

      public UITextArea(Atom propertyAtom, GProp<?>[] newValue) throws PropException
      Creates the component with the specified name, initialized to contain the GProp items. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - The name of the component, unique within it's parent.
      newValue - The array of all properties the component should have.
      Throws:
      PropException - when at least one of the properties to initialize the component with is invalid.

  • Method Details

    • getApproximateSize

      public Size getApproximateSize()
      Returns the size of the component in pixels. The size is a calculation and does not exactly reflect the real size that may be different due to additional styles not taken into account by this method. The size is calculated from the font of the component and default or defined values (such as character length or number of lines for text area).
      Overrides:
      getApproximateSize in class UIText
      Returns:
      The size of the component.

    • getVerticalExpand

      public boolean getVerticalExpand()
      Gets the vertical expand option.
      Returns:
      The expand option.

    • setVerticalExpand

      public boolean setVerticalExpand(boolean on)
      Sets the vertical expand option.
      Parameters:
      on - Set the expand option.
      Returns:
      true for value changed, false for no change.

    • getRows

      public int getRows()
      Gets number of rows.
      Returns:
      The rows option.

    • setRows

      public boolean setRows(int rows) throws IllegalArgumentException
      Sets the number of rows.
      Parameters:
      rows - The number of rows set.
      Returns:
      Successful or not.
      Throws:
      IllegalArgumentException