HTMLField

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

planetj.html
Class HTMLField

java.lang.Object
  |
  +--planetj.html.HTMLElement
        |
        +--planetj.html.HTMLField

public class HTMLField
extends HTMLElement

!!DA (8/6/2003 9:23:32 AM) - documentation needed

Author:: PlanetJ Corporation

Field Summary

static String BLACK_CHECKMARK


static String BLACK_REQUIRED_ASTERICK


static String className
          Class name.

static String DEFAULT_CHECKMARK


static String DEFAULT_REQUIRED_ASTERICK_COLOR


static String RED_CHECKMARK


static String RED_REQUIRED_ASTERICK


static String WHITE_CHECKMARK


static String WHITE_REQUIRED_ASTERICK


Fields inherited from class planetj.html.HTMLElement

DISABLED

Constructor Summary

HTMLField()
          Creates a new HTMLTableProperties object and sets its table id.

HTMLField(Field fld)
          Creates a new HTMLTableProperties object and sets its table id.

Method Summary

static StringBuffer appendAnchor(String name, StringBuffer html)
          Appends an anchor to allow for going directly to the given Field on the page.

static StringBuffer appendAssociation(Field field, Operation operation, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendAssociation(Field field, Operation operation, String linkText, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendAutoPopulateButton(String id, Field field, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generates a HTML text input for the given Field and arguements.

static StringBuffer appendCheckbox(Field field, String attributes, int row, int column, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLInput.appendCheckbox(.....)

static StringBuffer appendCheckbox(Field field, String attributes, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLInput.appendCheckbox(.....)

static StringBuffer appendCheckbox(String id, Field field, String attributes, int x, int y, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLInput.appendCheckbox(.....)

static StringBuffer appendCheckbox(String id, Field field, String attributes, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLInput.appendCheckbox(.....)

StringBuffer appendCheckbox(String attributes, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, StringBuffer sb)
          Deprecated. replaced by HTMLInput.appendCheckbox(.....)

StringBuffer appendCheckbox(String attributes, int rcNavIndex, int rowNavIndex, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, StringBuffer html)
          Deprecated. replaced by HTMLInput.appendCheckbox(...)

static StringBuffer appendDisplayValue(Field field, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns a StringBuffer representing the Field's value in HTML text.

StringBuffer appendDisplayValue(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, StringBuffer sb)
          Returns a StringBuffer representing the Field's value in HTML text.

static StringBuffer appendDisplayValue(String id, Field field, StringBuffer originalHTML, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns a StringBuffer representing the Field's value in HTML text.

static StringBuffer appendFileUploadButton(String id, Field field, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generates a HTML text input for the given Field and arguements.

static StringBuffer appendHelp(Field field, StringBuffer html)
          Appends help text onto the StringBuffer.

static StringBuffer appendHiddenSelectionInputs(StringBuffer html, javax.servlet.http.HttpServletRequest request)
          Appends HTML code for the JavaScript and hidden fields needed for Row and Field selection without radio buttons or checkboxes to track which object has been selected.

static StringBuffer appendInput(Field field, int size, int size2, String attributes, String rcNavKey, String rowNavKey, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendInput(Field field, int size, String attributes, String rcNavKey, String rowNavKey, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendInput(Field field, String attributes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendInput(String id, Field field, int size, int size2, String attributes, String rcNavKey, String rowNavKey, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendInput(String id, Field field, int size, String attributes, String rcNavKey, String rowNavKey, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendLabel(Field field, boolean labelFromValue, boolean includeColon, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendLabel(Field field, boolean includeColon, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


static StringBuffer appendLabel(Field field, int maxLength, boolean labelFromValue, boolean includeColon, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


StringBuffer appendLabel(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, StringBuffer sb)
          Deprecated. replaced by appendLabel(Field, boolean, StringBuffer, HttpServletRequest, HttpServletResponse)

static StringBuffer appendLabelExceptionCheckmark(Field field, StringBuffer html)


static StringBuffer appendPossibleValuesSearch(String id, Field field, int size, String attributes, String rcNavKey, String rowNavKey, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generates a HTML text input for the given Field and arguements.

static StringBuffer appendStatusChangeCall(Field fld, String javaScriptEvent, String rcNavKey, String rowNavKey, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, StringBuffer sb)


static String generateDisplayValue(Field field, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)


String generateDisplayValue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. repaced with appendDisplayValue(HttpServletRequest, HttpServletResponse, StringBuffer)

StringBuffer generateHidden(StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLInput.appendHiddenInput(....)

String generateInput(int size, String attributes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with appendInput(.....)

String generateInput(String attributes, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Deprecated.

String generateLabel(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Returns a String representing the Field's external name as a bold label.

String generateLabelAndField(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Returns a String representing the Field's and its label.

String generateLabelAndInput(int size, String inputAttributes, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Returns a String representing the Field's as input of specified size and also a label.

String generateLabelAndInput(String inputAttributes, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Returns a String representing the Field's as input and its label.

String generateLabelDisplayDetails(Field pField)
          This will generate display details if it is turned on.

String generateRadio(String attributes, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced by HTMLInput.appendRadioInput(....)

StringBuffer generateTextArea(int rows, int cols, String attributes, int row, int col, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with generateTextArea(int, int, String, StringBuffer, HttpServletRequest, HttpServletResponse)

StringBuffer generateTextArea(int cols, int rows, String attributes, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. replaced with HTMLTextArea.appendTextArea(String, Field, int, int, String, int, int, StringBuffer, HttpServletRequest, HttpServletResponse)

String getExceptionCheckmark()
          Possible values currently are RED_CHECKMARK BLACK_CHECKMARK WHITE_CHECKMARK Creation date: (5/15/2002 8:46:47 PM)

Field getField()
          Returns the HTMLField's Field.

Boolean getJavaScriptFieldValidationEnabled()
          Returns whether this field should be use JS Validation.

int getMaxWidth()
          Gets the maximum width that a field's input will take up on the screen (the default is 100).

String getRCNavKey()


String getRequiredAsterickColor()
          Possible values currently are below, but you can pass in any valid html color RED_REQUIRED_ASTERICK WHITE_REQUIRED_ASTERICK BLACK_REQUIRED_ASTERICK

String getRowNavKey()


boolean isDisplayDetails()
          This will toggle the details of a field to be displayed or not.

boolean isDisplayEditFDs()
          Tests if an FD link should be displayed next to the field

static boolean isEnableJavaScriptValidation(javax.servlet.http.HttpServletRequest request)
          Check to see if JavaScript Validation is enabled.

boolean isIncludeColonAfterLabel()
          This can be set to true if you want a colon {:} placed after each label Creation date: (5/15/2002 8:53:17 PM)

boolean isJavaScriptValidationEnabled(javax.servlet.http.HttpServletRequest req)
          Returns whether this field should be use JS Validation considering the 3 levels listed below.

void setDisplayDetails(boolean newDisplayDetails)
          This will toggle the details of a field to be displayed or not.

void setDisplayEditFDs(boolean newDisplayFDLink)
          Sets if an FD link should be displayed next to the field

void setExceptionCheckmark(String newExceptionCheckmark)
          You can pass in the check mark color you want to sue.

HTMLField setField(Field fld)
          Sets the HTMLField's Field.

void setIncludeColonAfterLabel(boolean newIncludeColonAfterLabel)
          This can be set to true if you want a colon {:} placed after each label Creation date: (5/15/2002 8:53:17 PM)

void setJavaScriptFieldValidationEnabled(boolean newJavaScriptFieldValidation)
          This will set JavaScript validation on the field level.

void setMaxWidth(int newMaxWidth)
          Sets the maximum width that a field's input will take up on the screen (the default is 100).

void setRCNavKey(String key)


void setRequiredAsterickColor(String newRequiredAsterickColor)
          Possible values currently are below, but you can pass in any valid html color RED_REQUIRED_ASTERICK WHITE_REQUIRED_ASTERICK BLACK_REQUIRED_ASTERICK

void setRowNavKey(String key)


Methods inherited from class planetj.html.HTMLElement

appendAttribute, appendAttribute, appendExtractableHiddenField, getId, isDisplayField, setId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

className

public static final String className

Class name.

RED_CHECKMARK

public static final String RED_CHECKMARK

See Also:: Constant Field Values

WHITE_CHECKMARK

public static final String WHITE_CHECKMARK

See Also:: Constant Field Values

BLACK_CHECKMARK

public static final String BLACK_CHECKMARK

See Also:: Constant Field Values

DEFAULT_CHECKMARK

public static final String DEFAULT_CHECKMARK

See Also:: Constant Field Values

RED_REQUIRED_ASTERICK

public static final String RED_REQUIRED_ASTERICK

See Also:: Constant Field Values

WHITE_REQUIRED_ASTERICK

public static final String WHITE_REQUIRED_ASTERICK

See Also:: Constant Field Values

BLACK_REQUIRED_ASTERICK

public static final String BLACK_REQUIRED_ASTERICK

See Also:: Constant Field Values

DEFAULT_REQUIRED_ASTERICK_COLOR

public static final String DEFAULT_REQUIRED_ASTERICK_COLOR

See Also:: Constant Field Values

Constructor Detail

HTMLField

public HTMLField()

Creates a new HTMLTableProperties object and sets its table id.

HTMLField

public HTMLField(Field fld)

Creates a new HTMLTableProperties object and sets its table id.

Method Detail

appendAnchor

public static StringBuffer appendAnchor(String name,
                                        StringBuffer html)
                                 throws CMException

Appends an anchor to allow for going directly to the given Field on the page.

Parameters:: name - name of HTML element genarating anchor above; html - buffer to append HTML code to
Returns:: buffer HTML anchor was appended to; CMException

appendAssociation

public static StringBuffer appendAssociation(Field field,
                                             Operation operation,
                                             String linkText,
                                             StringBuffer html,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws CMException

CMException

appendAssociation

public static StringBuffer appendAssociation(Field field,
                                             Operation operation,
                                             StringBuffer html,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws CMException

CMException

appendAutoPopulateButton

public static StringBuffer appendAutoPopulateButton(String id,
                                                    Field field,
                                                    StringBuffer html,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                                             throws CMException

Generates a HTML text input for the given Field and arguements.

CMException