Package com.portal.bas

Class PFieldComponentImpl

java.lang.Object
com.portal.bas.PComponentImpl
com.portal.bas.PFieldComponentImpl
All Implemented Interfaces:
PComponent, PRemoteComponent, PViewDataChangeListener, Serializable, Remote, EventListener
public class PFieldComponentImpl extends PComponentImpl implements Serializable
Deprecated.
As of Release 6.1, PFieldComponentImpl is deprecated and replaced by PFieldDelegate.
PFieldComponentImpl is a PAppComponent that directly displays the contents of a field. This class was used as the base for displaying field contents, for example, single field controls, list boxes, and tables.
Version:
3
Author:
Larry Lynch-Freshner
See Also:

  • Constructor Details

  • Method Details

    • register

      public void register() throws RemoteException
      Deprecated.
      Overloads the register method. Forwards field descriptions to the controller.
      Overrides:
      register in class PComponentImpl
      Throws:
      RemoteException - thrown for all problems

    • setModelFieldDescription

      public void setModelFieldDescription(String fieldDesc) throws RemoteException
      Deprecated.
      Sets the description of the field of the data model that is most important to this component.
      Parameters:
      fieldDesc - a String that describes the field(s) used by this component
      Throws:
      RemoteException - thrown for all problems

    • getModelFieldDescription

      public String getModelFieldDescription() throws RemoteException
      Deprecated.
      Gets the data field description used by the component.
      Returns:
      A String description of the field(s) used by this component.
      Throws:
      RemoteException - thrown for all problems

    • setDisplayFieldDescription

      public void setDisplayFieldDescription(String fieldDisp) throws RemoteException
      Deprecated.
      Sets the description of the field of the data model that is most important to this component.
      Parameters:
      fieldDisp - a String that describes the field(s) used by this component
      Throws:
      RemoteException - thrown for all problems

    • getDisplayFieldDescription

      public String getDisplayFieldDescription() throws RemoteException
      Deprecated.
      Gets the data field description used by the component.
      Returns:
      A String description of the fields used by this component.
      Throws:
      RemoteException - thrown for all problems

    • setDisplayFieldFormat

      public void setDisplayFieldFormat(String fieldForm) throws RemoteException
      Deprecated.
      Sets the format used to display the field(s) described by the DisplayFieldDescription methods. This is a standard Java MessageFormat string.
      Parameters:
      fieldForm - the format string, or resource tag for format
      Throws:
      RemoteException - thrown for all problems

    • getDisplayFieldFormat

      public String getDisplayFieldFormat() throws RemoteException
      Deprecated.
      Gets the display format.
      Returns:
      A String that describes the message format.
      Throws:
      RemoteException - thrown for all problems

    • setHelpID

      public void setHelpID(String id)
      Deprecated.
      Sets the help ID for this component.
      Parameters:
      id - a String help ID

    • getHelpID

      public String getHelpID()
      Deprecated.
      Gets the current help ID for this component.
      Returns:
      A String help ID.

    • setAssociatedClass

      public void setAssociatedClass(String name)
      Deprecated.
      Sets the class name to associate with this component.
      Parameters:
      name - a String with the class name to associate

    • getAssociatedClass

      public String getAssociatedClass()
      Deprecated.
      Gets the class name to associate with this component.
      Returns:
      A String with the associated class name.

    • getFormatter

      public PInfranetMessageFormat getFormatter() throws IllegalComponentStateException
      Deprecated.
      Gets a formatter for component data.
      Returns:
      A PInfranetMessageFormat object that can deal with permissions.
      Throws:
      IllegalComponentStateException - thrown if the component is not yet a child of a valid view tree, for example, before addNotify() is called

    • formatData

      public String formatData(Object val) throws IllegalComponentStateException
      Deprecated.
      Formats data for the component.
      Parameters:
      val - the data to be formatted. If the format needs multiple parameters, then val should be a Vector or an Object array.
      Returns:
      A formatted String.
      Throws:
      IllegalComponentStateException - thrown if the component is not yet a child of a valid view tree, for example, before addNotify() is called

    • getRenderer

      public PFieldComponentRenderer getRenderer() throws IllegalComponentStateException
      Deprecated.
      Gets a PFieldComponentRenderer for this component. The renderer uses an Portal-aware, permissions-based formatter, and is suitable for lists or tables.
      Returns:
      A new PFieldComponentRenderer object.
      Throws:
      IllegalComponentStateException - thrown if the component is not yet a child of a valid view tree, for example, before addNotify() is called