rs.sol.soloist.server.guiconfiguration.components
Class GUIApplicationComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
                          rs.sol.soloist.server.guiconfiguration.components.GUIApplicationComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIApplicationComponent
extends GUIContainerComponent

The root widget in a GUI tree. This widget can be viewed as a web page, or as a single-page web application. Strictly has a single child widget, which is typically a panel to which all other widgets must ultimatively be added.

Code example:

 GUIApplicationComponent app = new GUIApplicationComponent();
 app.setName("Example App");
 GUIPanelComponent rootPanel = GUIPanelComponent.createFlow(app);
 rootPanel.add(...);
 rootPanel.add(...);
 
 




Author:
  
SOL Expert Group







Nested Class Summary




static class
GUIApplicationComponent.FQPropertyNames



          Deprecated. Not for public use.



static class
GUIApplicationComponent.PROPERTIES



          Deprecated. Not for public use.


 


Field Summary




static IClass
CLASSIFIER



          UML class reference



 IAttributeValue<File>
cssFile1



          Deprecated. Not for public use.



 IAttributeValue<File>
cssFile2



          Deprecated. Not for public use.



 IAttributeValue<File>
cssFile3



          Deprecated. Not for public use.



 IAttributeValue<Text>
cssURLs



          Deprecated. Not for public use.



 IAssociationEndInstance<GUIDialogComponent>
dialogs



          Deprecated. Not for public use.



 IAttributeValue<Text>
doctype



          Deprecated. Not for public use.



 IAttributeValue<Picture>
favIcon



          Deprecated. Not for public use.



 IAttributeValue<Text>
favIconURL



          Deprecated. Not for public use.



static java.lang.String
FQ_TYPE_NAME



          Fully qualified UML class name



 IAttributeValue<Text>
scrollToTop



          Deprecated. Not for public use.



 IAttributeValue<Text>
start



          Deprecated. Not for public use.



 IAttributeValue<Text>
title



          Deprecated. Not for public use.


 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
back, children, forward, input, logger, next, output, previous, refresh, reset, submit, visibleChild
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyle, context, description, enabled, init, inputBindings, layoutData, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible
 



Constructor Summary
GUIApplicationComponent()



           
 



Method Summary




 void
addDialog(GUIDialogComponent d)



          Adds a GUIDialogComponent to this widget.



 void
clearDialogs()



          Clears all dialogs from this widget.



 void
constructor()



          The domain-specific constructor of the Classifier.



static GUIApplicationComponent
findByName(java.lang.String name)



          Deprecated. Not for public use.



static GUIApplicationComponent
get(GUIComponent c)



          Deprecated. Not for public use.



 java.io.File
getCssFile1()



          Returns the first CSS file.



 java.io.File
getCssFile2()



          Returns the second CSS file.



 java.io.File
getCssFile3()



          Returns the third CSS file.



 java.lang.String[]
getCssURLs()



          Returns an array of the CSS URLs set for this widget.



 java.lang.String
getDoctype()



          Sets the doctype of a web page resembled by this
 widget.



 java.io.File
getFavIcon()



          Returns the favicon file.



 java.lang.String
getFavIconURL()



          Returns the favicon URL.



 java.lang.String
getTitle()



          Returns this widget's title.



 ISlot<?>
ipScrollToTop()



          Returns the scrollToTop input pin; when event occurs,
 the web page will immediately be scrolled up to the top.



 ISlot<?>
ipTitle()



          Returns the title input pin; when event occurs,
 the textual binding message content will become a new title of 
 this widget.



 ISlot<?>
opStart()



          Returns the start output pin; when this widget
 finishes with construction of its whole sub-tree (which represents
 the application or a web page) it issues an empty binding message
 to signal this event to other interested widget.



 void
removeDialog(GUIDialogComponent d)



          Removes a GUIDialogComponent from this widget.



 void
setCssFile1(java.io.File css1)



          Sets the first CSS file.



 void
setCssFile2(java.io.File css2)



          Sets the second CSS file.



 void
setCssFile3(java.io.File css3)



          Sets the third CSS file.



 void
setCssURLs(java.lang.String... cssURLs)



          Sets an array of the CSS URLs of the CSS files that
 will be used in the (sub)tree of this widget.



 void
setDoctype(java.lang.String doctype)



          Sets the doctype of the web page resembled by this 
 widget.



 void
setFavIcon(java.io.File favicon)



          Sets the favicon file.



 void
setFavIconURL(java.lang.String faviconURL)



          Sets the favicon URL.



 void
setTitle(java.lang.String title)



          Sets this widget's title



 void
validate()



          Validates a configuration settings of this widget.


 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
add, addFirst, clear, get, getVisibleChild, ipBack, ipForward, ipNext, ipPrevious, ipRefresh, ipRelay1, ipRelay2, ipReset, ipSubmit, ipVisibleChild, opRelay1, opRelay2, opVisibleChild, remove, removeFirst, setVisibleChild, validateSingleChild
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validateParts, validateParts
 
Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString
 
Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted
 
Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance
conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf
 
Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement
getMElement
 
Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement
isKindOf, isModelElement, isRTElement
 





Field Detail



start
@Deprecated
public final IAttributeValue<Text> start

Deprecated. Not for public use.






title
@Deprecated
public final IAttributeValue<Text> title

Deprecated. Not for public use.






scrollToTop
@Deprecated
public final IAttributeValue<Text> scrollToTop

Deprecated. Not for public use.






cssURLs
@Deprecated
public final IAttributeValue<Text> cssURLs

Deprecated. Not for public use.






cssFile1
@Deprecated
public final IAttributeValue<File> cssFile1

Deprecated. Not for public use.






cssFile2
@Deprecated
public final IAttributeValue<File> cssFile2

Deprecated. Not for public use.






cssFile3
@Deprecated
public final IAttributeValue<File> cssFile3

Deprecated. Not for public use.






favIconURL
@Deprecated
public final IAttributeValue<Text> favIconURL

Deprecated. Not for public use.






favIcon
@Deprecated
public final IAttributeValue<Picture> favIcon

Deprecated. Not for public use.






doctype
@Deprecated
public final IAttributeValue<Text> doctype

Deprecated. Not for public use.






FQ_TYPE_NAME
public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name


See Also:
Constant Field Values




CLASSIFIER
public static final IClass CLASSIFIER

UML class reference







dialogs
@Deprecated
public final IAssociationEndInstance<GUIDialogComponent> dialogs

Deprecated. Not for public use.







Constructor Detail



GUIApplicationComponent
public GUIApplicationComponent()






Method Detail



constructor
public void constructor()

Description copied from interface: IClassifierInstance
The domain-specific constructor of the Classifier.


Specified by:
constructor in interface IClassifierInstance
Overrides:
constructor in class GUIContainerComponent








validate
public void validate()

Description copied from class: GUIComponent
Validates a configuration settings of this widget.


Overrides:
validate in class GUIContainerComponent








get
@Deprecated
public static GUIApplicationComponent get(GUIComponent c)

Deprecated. Not for public use.








findByName
@Deprecated
public static GUIApplicationComponent findByName(java.lang.String name)

Deprecated. Not for public use.








ipTitle
public ISlot<?> ipTitle()

Returns the title input pin; when event occurs,
 the textual binding message content will become a new title of 
 this widget.



Returns:
the title input pin
See Also:
GUIComponentBinding





ipScrollToTop
public ISlot<?> ipScrollToTop()

Returns the scrollToTop input pin; when event occurs,
 the web page will immediately be scrolled up to the top. The binding 
 message content is of no importance. Only event is what matters.



Returns:
the scrollToTop input pin
See Also:
GUIComponentBinding





opStart
public ISlot<?> opStart()

Returns the start output pin; when this widget
 finishes with construction of its whole sub-tree (which represents
 the application or a web page) it issues an empty binding message
 to signal this event to other interested widget.



Returns:
the start output pin
See Also:
GUIComponentBinding





getCssURLs
public java.lang.String[] getCssURLs()

Returns an array of the CSS URLs set for this widget.



Returns:
an array of the CSS URLs set for this widget
See Also:
setCssURLs(String...)





setCssURLs
public void setCssURLs(java.lang.String... cssURLs)

Sets an array of the CSS URLs of the CSS files that
 will be used in the (sub)tree of this widget.


Parameters:
cssURLs - an array of the CSS URLs





getFavIconURL
public java.lang.String getFavIconURL()

Returns the favicon URL.



Returns:
the favicon URL
See Also:
setFavIconURL(String)





setFavIconURL
public void setFavIconURL(java.lang.String faviconURL)

Sets the favicon URL.


Parameters:
faviconURL - the favicon URL





getTitle
public java.lang.String getTitle()

Returns this widget's title.



Returns:
this widget's title
See Also:
setTitle(String)





setTitle
public void setTitle(java.lang.String title)

Sets this widget's title


Parameters:
title - the new title





getDoctype
public java.lang.String getDoctype()

Sets the doctype of a web page resembled by this
 widget.



Returns:
the doctype of a web page resembled by this
         widget
See Also:
setDoctype(String)





setDoctype
public void setDoctype(java.lang.String doctype)

Sets the doctype of the web page resembled by this 
 widget.


Parameters:
doctype - the doctype of this web page





getCssFile1
public java.io.File getCssFile1()

Returns the first CSS file.



Returns:
the first CSS file
See Also:
setCssFile1(java.io.File)





setCssFile1
public void setCssFile1(java.io.File css1)
                 throws java.io.IOException

Sets the first CSS file.


Parameters:
css1 - the first CSS file
Throws:
java.io.IOException





getCssFile2
public java.io.File getCssFile2()

Returns the second CSS file.



Returns:
the second CSS file
See Also:
setCssFile2(java.io.File)





setCssFile2
public void setCssFile2(java.io.File css2)
                 throws java.io.IOException

Sets the second CSS file.


Parameters:
css2 - the secondCSS file
Throws:
java.io.IOException





getCssFile3
public java.io.File getCssFile3()

Returns the third CSS file.



Returns:
the third CSS file
See Also:
setCssFile3(java.io.File)





setCssFile3
public void setCssFile3(java.io.File css3)
                 throws java.io.IOException

Sets the third CSS file.


Parameters:
css3 - the third CSS file
Throws:
java.io.IOException





getFavIcon
public java.io.File getFavIcon()

Returns the favicon file.



Returns:
the favicon file
See Also:
setFavIcon(java.io.File)





setFavIcon
public void setFavIcon(java.io.File favicon)
                throws java.io.IOException

Sets the favicon file.


Parameters:
favicon - the favicon file
Throws:
java.io.IOException





addDialog
public void addDialog(GUIDialogComponent d)

Adds a GUIDialogComponent to this widget.


Parameters:
d - the dialog to be added





removeDialog
public void removeDialog(GUIDialogComponent d)

Removes a GUIDialogComponent from this widget.


Parameters:
d - the dialog to be removed





clearDialogs
public void clearDialogs()

Clears all dialogs from this widget.