Package overit.geocall.basic.ui.control

Class Output

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.Output
All Implemented Interfaces:
Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, Arrangeable, Badgeable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable
Direct Known Subclasses:
MultiDecoder, OutputBarcode, OutputCheckBox, OutputCurrency, OutputDate, OutputDouble, OutputDTZ, OutputECS, OutputLong, OutputLookup, OutputProgress, OutputSpan, OutputStaticView, OutputSwitch, OutputTime, OutputTimeRange, OutputXML
@Component public class Output extends Control implements Arrangeable
This class, which extends Control, implements the graphic user interface object that must be used for the presentation of non-modifiable data. The contents of the output fields will not be passed as parameters when you submit the Form that contains them.
See Also:
GCApi:
component

  • Field Details

    • _minlength

      protected int _minlength

    • _value

      protected String _value

    • _key

      protected boolean _key

    • _numeric

      protected boolean _numeric

    • _nowrap

      protected boolean _nowrap

    • truncate

      protected int truncate

    • _strong

      protected boolean _strong

    • _size

      protected String _size

    • valueWrap

      protected boolean valueWrap

    • _event

      protected ListAttribute _event

    • _param

      protected ListAttribute _param

    • _msg

      protected ListAttribute _msg

    • _prompt

      protected ListAttribute _prompt

    • promptEmpty

      protected boolean promptEmpty

    • _eventtitle

      protected ListAttribute _eventtitle

    • _eventicon

      protected ListAttribute _eventicon

    • _eventsnumber

      protected int _eventsnumber

    • _ff

      protected ForeignField _ff

    • _label2

      protected String _label2

  • Constructor Details

    • Output

      public Output()
      Creates a generic Output used to contains string values

  • Method Details

    • setVALUE

      public void setVALUE(String s)
      Sets forcibly the value of the output
      Parameters:
      s - The value of the output

    • setKEY

      public void setKEY(String s)
      Indicates if the field is a key field.
      At each key field is assigned a particular CSS style that makes it more evident inside the form, style based on the specific theme currently used
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setNUMERIC

      public void setNUMERIC(String s)
      Indicates if the field value should be considered as a numeric from the aspect point of view (right alignment and italic font)
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setNOWRAP

      public void setNOWRAP(String s)
      Defines if the value will never wrap to the next line, ie the text continues on the same line until a <br> tag is encountered
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setVALUEWRAP

      public void setVALUEWRAP(String s)
      Defines if the value will never wrap to the next line, ie the text continues on the same line until a <br> tag is encountered
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setSTRONG

      public void setSTRONG(String s)
      Indicates if the field is a strong field.
      At each strong field is assigned a particular CSS style that makes it more evident inside the form, style based on the specific theme currently used
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setTRUNCATE

      public void setTRUNCATE(String s)
      Sets the maximum displayed length of the content. If the content is longer, it is truncated to the maximum length.
      Parameters:
      s - The maximum displayed length for the value, expressed in number of characters

    • setMINLENGTH

      public void setMINLENGTH(String s)
      Sets the minimum length of the content. If the content is shorter, it will be filled with spaces, up to the minimum length.
      Parameters:
      s - The minimum length for the option. The default value is 10 characters.

    • setSIZE

      public void setSIZE(String s)
      Sets the size of the field
      Parameters:
      s - The integer that defines the size (expressed in em) of the field

    • setEVENT

      public void setEVENT(String s)
      Sets one or more events associated to the output field.
      By setting an event, a button will be created inside the field, clicking on which the event will be triggered. Each button will have a default icon.
      Parameters:
      s - A ListAttribute of strings (separated by the character | ) each of which represents the name of an event associated to the field

    • setEVENTMSG

      public void setEVENTMSG(String s)
      Sets one (or more) string that appear as messages for the events associated to the field (see setEVENT()).
      For the association event - message, it counts the position in which the attributes appear. If the messages are fewer than the events, the last message of the list is associated with all the remaining events.
      Parameters:
      s - A ListAttribute of strings (separated by the character | ) each of which represents the msg attribute of an event associated to the field

    • setEVENTPARAM

      public void setEVENTPARAM(String s)
      Sets one (or more) parameter for the events associated to the field (see setEVENT()).
      For the association event - parameter, it counts the position in which the attributes appear. If the parameters are fewer than the events, the last parameter of the list is associated with all the remaining events.
      Parameters:
      s - A ListAttribute of strings (separated by the character | ) each of which represents the param attribute of an event associated to the field

    • setEVENTPROMPT

      public void setEVENTPROMPT(String s)
      Sets one (or more) string that appear as prompt for the events associated to the field (see setEVENT()).
      For the association event - prompt, it counts the position in which the attributes appear. If the prompts are fewer than the events, the last prompt of the list is associated with all the remaining events.
      Parameters:
      s - A ListAttribute of strings (separated by the character | ) each of which represents the prompt attribute of an event associated to the field

    • setPROMPTEMPTY

      public void setPROMPTEMPTY(String s)
      Sets if the value returned by the prompt can be an empty string ""
      Parameters:
      s - true if you want to allow to return an empty value by the prompt, false otherwise.

    • setEVENTTITLE

      public void setEVENTTITLE(String s)
      Sets one (or more) string that appear as tooltip when the user positions the cursor over the button of an event associated to the field (see setEVENT()).
      For the association event - title, it counts the position in which the attributes appear. If the titles are fewer than the events, the last title of the list is associated with all the remaining events.
      Parameters:
      s - A ListAttribute of strings (separated by the character | ) each of which represents the title attribute of an event associated to the field

    • setICON

      public void setICON(String icon)
      Sets one (or more) icon that is associated to the button of an event associated to the field (see setEVENT()).
      For the association event button - icon, it counts the position in which the attributes appear. If the icons are fewer than the events, the last icon of the list is associated with all the remaining events.
      Overrides:
      setICON in class Component
      Parameters:
      icon - A ListAttribute of strings (separated by the character | ) each of which represents the path of an icon associated to a button of an event on the field

    • setLABEL2

      public void setLABEL2(String s)
      Sets a second label right next the first one. If labelInLine is true the separator will be " ", if is false it will be a simple " ". Using this method the string will be translated by the Teacher
      Parameters:
      s - The string that will appear as the second label

    • setNAME

      public void setNAME(String s)
      Sets the name of the component.
      Overrides:
      setNAME in class Component
      Parameters:
      s - The name of the component

    • prepareValue

      protected String prepareValue()

    • setStyle

      protected void setStyle(org.apache.ecs.ElementAttributes d)

    • getHtmlValue

      protected org.apache.ecs.Element getHtmlValue(EntitySet es)

    • getContentHtml

      public org.apache.ecs.Element getContentHtml(Object generationhandle, EntitySet es)
      Description copied from interface: Arrangeable
      Returns the html code that represents the active part of the component, i.e. the field and the validation scripts
      Specified by:
      getContentHtml in interface Arrangeable
      Parameters:
      generationhandle - the unique generatin handle
      es - the page entity set
      Returns:
      The html code of the component

    • getHtml

      public org.apache.ecs.Element getHtml(EntitySet es)
      Description copied from class: Component
      Abstract method that must be extended and returns the html code of the Component
      Specified by:
      getHtml in class Component
      Parameters:
      es - The EntitySet to which the element belongs
      Returns:
      The html of the Component

    • getHiddenHtml

      public org.apache.ecs.Element getHiddenHtml(Object generationhandle, EntitySet es)
      Description copied from interface: Arrangeable
      Returns the hidden but active html part of an hidden component
      Specified by:
      getHiddenHtml in interface Arrangeable
      Parameters:
      generationhandle - the unique generatin handle
      es - the page entity set
      Returns:
      The html code of the hidden part of the component

    • getGenerationHandle

      public Object getGenerationHandle()
      Description copied from interface: Arrangeable
      Returns the object to generate when the Arrangeable element is composed by more than one element
      Specified by:
      getGenerationHandle in interface Arrangeable
      Returns:
      The Object to generate

    • getDescriptionHtml

      public org.apache.ecs.Element getDescriptionHtml(Object generationhandle, EntitySet es)
      Description copied from interface: Arrangeable
      Returns the html code that represents the component description i.e. the formatted label of the field
      Specified by:
      getDescriptionHtml in interface Arrangeable
      Parameters:
      generationhandle - the unique generatin handle
      es - the page entity set
      Returns:
      The html code of the label of the field