All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.havi.ui.HMultilineEntry Maven / Gradle / Ivy

There is a newer version: 1.3.1
Show newest version
package org.havi.ui;

/*
 * Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
 * Microsystems, Inc. All rights reserved.  
 */


/**
   The {@link org.havi.ui.HMultilineEntry HMultilineEntry} is a user interface
   component used to receive multiple lines of alphanumeric entry from
   the user.
   

A call to the inherited method setDefaultLook(HSinglelineEntry) shall behave the same as a call to {@link HSinglelineEntry#setDefaultLook}.


The parameters to the constructors are as follows, in cases where parameters are not used, then the constructor should use the default values.

Default parameter values exposed in the constructors

ParameterDescriptionDefault value Set methodGet method
x x-coordinate of top left hand corner of this component in pixels, relative to its parent container (subject to layout management). --- java.awt.Component#setBounds java.awt.Component#getBounds
y y-coordinate of top left hand corner of this component in pixels, relative to its parent container (subject to layout management). --- java.awt.Component#setBounds java.awt.Component#getBounds
width width of this component in pixels (subject to layout management). --- java.awt.Component#setBounds java.awt.Component#getBounds
height height of this component in pixels (subject to layout management). --- java.awt.Component#setBounds java.awt.Component#getBounds
text The text within this {@link org.havi.ui.HMultilineEntry}, to be used as the displayed and editable content for all states. null {@link org.havi.ui.HVisible#setTextContent} {@link org.havi.ui.HVisible#getTextContent}
maxChars The maximum number of characters allowed in this {@link org.havi.ui.HMultilineEntry}. 16 characters {@link org.havi.ui.HSinglelineEntry#setMaxChars} {@link org.havi.ui.HSinglelineEntry#getMaxChars}
font The font to be used for this component. --- java.awt.Component#setFont. java.awt.Component#getFont.
color The color to be used for this component. --- java.awt.Component#setForeground. java.awt.Component#getForeground.

Default parameter values not exposed in the constructors

DescriptionDefault valueSet method Get method
Associated matte ({@link org.havi.ui.HMatte HMatte}). none (i.e. getMatte() returns null) {@link org.havi.ui.HComponent#setMatte setMatte} {@link org.havi.ui.HComponent#getMatte getMatte}
The text layout manager responsible for text formatting. An {@link org.havi.ui.HDefaultTextLayoutManager} object. {@link org.havi.ui.HVisible#setTextLayoutManager} {@link org.havi.ui.HVisible#getTextLayoutManager}
The background painting mode {@link org.havi.ui.HVisible#NO_BACKGROUND_FILL} {@link org.havi.ui.HVisible#setBackgroundMode} {@link org.havi.ui.HVisible#getBackgroundMode}
The default preferred size not set (i.e. NO_DEFAULT_SIZE) unless specified by width and height parameters {@link org.havi.ui.HVisible#setDefaultSize} {@link org.havi.ui.HVisible#getDefaultSize}
The horizontal content alignment {@link org.havi.ui.HVisible#HALIGN_CENTER} {@link org.havi.ui.HVisible#setHorizontalAlignment} {@link org.havi.ui.HVisible#getHorizontalAlignment}
The vertical content alignment {@link org.havi.ui.HVisible#VALIGN_CENTER} {@link org.havi.ui.HVisible#setVerticalAlignment} {@link org.havi.ui.HVisible#getVerticalAlignment}
The content scaling mode {@link org.havi.ui.HVisible#RESIZE_NONE} {@link org.havi.ui.HVisible#setResizeMode} {@link org.havi.ui.HVisible#getResizeMode}
The border mode true {@link org.havi.ui.HVisible#setBordersEnabled} {@link org.havi.ui.HVisible#getBordersEnabled}
Caret position At the end of the current text string {@link HSinglelineEntry#setCaretCharPosition} {@link HSinglelineEntry#getCaretCharPosition}
Input type {@link HSinglelineEntry#INPUT_ANY} {@link HSinglelineEntry#setType} {@link HSinglelineEntry#getType}
Customized input range null {@link HSinglelineEntry#setValidInput} {@link HSinglelineEntry#getValidInput}
Password protection (the echo character) Zero (ASCII NUL), i.e. not password protected. {@link HSinglelineEntry#setEchoChar} {@link HSinglelineEntry#getEchoChar} and {@link HSinglelineEntry#echoCharIsSet}
The default "look" for this class. A platform specific {@link org.havi.ui.HMultilineEntryLook HMultilineEntryLook} {@link org.havi.ui.HMultilineEntry#setDefaultLook HMultilineEntry.setDefaultLook} {@link org.havi.ui.HMultilineEntry#getDefaultLook HMultilineEntry.getDefaultLook}
The "look" for this object. The {@link org.havi.ui.HMultilineEntryLook HMultilineEntryLook} returned from HMultilineEntry.getDefaultLook when this object was created. {@link org.havi.ui.HMultilineEntry#setLook HMultilineEntry.setLook} {@link org.havi.ui.HMultilineEntry#getLook HMultilineEntry.getLook}
The gain focus sound. null {@link org.havi.ui.HMultilineEntry#setGainFocusSound setGainFocusSound} {@link org.havi.ui.HMultilineEntry#getGainFocusSound getGainFocusSound}
The lose focus sound. null {@link org.havi.ui.HMultilineEntry#setLoseFocusSound setLoseFocusSound} {@link org.havi.ui.HMultilineEntry#getLoseFocusSound getLoseFocusSound}
*/ public class HMultilineEntry extends HSinglelineEntry { /** * Creates an {@link org.havi.ui.HMultilineEntry HMultilineEntry} * object. See the class description for details of constructor * parameters and default values. */ public HMultilineEntry() { } /** * Creates an {@link org.havi.ui.HMultilineEntry HMultilineEntry} * object. See the class description for details of constructor * parameters and default values. */ public HMultilineEntry(String text, int x, int y, int width, int height, int maxChars, java.awt.Font font, java.awt.Color color) { } /** * Creates an {@link org.havi.ui.HMultilineEntry HMultilineEntry} * object. See the class description for details of constructor * parameters and default values. */ public HMultilineEntry(int x, int y, int width, int height, int maxChars) { } /** * Creates an {@link org.havi.ui.HMultilineEntry HMultilineEntry} * object. See the class description for details of constructor * parameters and default values. */ public HMultilineEntry(String text, int maxChars, java.awt.Font font, java.awt.Color color) { } /** * Creates an {@link org.havi.ui.HMultilineEntry HMultilineEntry} * object. See the class description for details of constructor * parameters and default values. */ public HMultilineEntry(int maxChars) { } /** * Sets the default look for further {@link * org.havi.ui.HMultilineEntry HMultilineEntry} Components. * * @param look The look that will be used by default when creating * a new {@link org.havi.ui.HMultilineEntry HMultilineEntry} * component. * Note that this parameter may be null, in which case newly * created components shall not draw themselves until a non-null * look is set using the {@link * org.havi.ui.HSinglelineEntry#setLook setLook} method. */ public static void setDefaultLook(HMultilineEntryLook look) { } /** * Returns the currently set default look for {@link * org.havi.ui.HMultilineEntry HMultilineEntry} components. * * @return The {@link org.havi.ui.HMultilineEntryLook * HMultilineEntryLook} that is used by default when creating a * new {@link org.havi.ui.HMultilineEntry HMultilineEntry} * component, cast to an {@link org.havi.ui.HSinglelineEntryLook * HSinglelineEntryLook}. */ public static HSinglelineEntryLook getDefaultLook() { return (null); } /** * Sets the {@link org.havi.ui.HLook HLook} for this component. * * @param hlook The {@link org.havi.ui.HLook HLook} that is to be * used for this component. * @exception HInvalidLookException If the Look is not an {@link * org.havi.ui.HMultilineEntryLook HMultilineEntryLook}. */ public void setLook(HLook hlook) throws HInvalidLookException { } /** * Move the caret to the same column position on the next line. * If the caret would be past the end of the text on the line the * new caret position will be at the end of the line. */ public void caretNextLine() { } /** * Move the caret to the same column position on the previous * line. If the caret would be past the end of the text on the * line the new caret position will be at the end of the line. */ public void caretPreviousLine() { } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy