org.eclipse.osbp.ecview.dsl.lib/src/org/eclipse/osbp/ecview/dsl/lib/Defaults.uisemantic

ePackage "http://osbp.eclipse.org/ecview/dsl/uimodel/core" as view

element Embeddable {
	uri view:UiEmbeddable
	  
	bindings {
		
		/**
		 * Name property of the UI element.
		 */
		endpoint name String
		
		/**
		 * Id property of the UI element.
		 */
		endpoint id String

		/** 
		 * Visible property of the UI element.
		 */
		endpoint visible Boolean
		
		/** 
		 * Initial Visible property of the UI element.
		 */
		endpoint initialVisible Boolean
		
		/** 
	 	 * contextClick property of the UI element.
		 */
		endpoint observeContextClick org.eclipse.osbp.ecview.core.common.model.core.YContextClickEvent target lastContextClick
		
		/**
		 * Styles property of the UI element.
		 */
		endpoint styles String target cssClass
		
		/**
		 * Caption property of the UI element.
		 */
		endpoint caption String target label
		
		/**
		 * Translated caption property of the UI element.
		 */
		endpoint captionI18n String target labelI18nKey
		
		/**
		 * Css Class property of the UI element.
		 */
		endpoint cssClass String
		
		/**
		 * Css Id property of the UI element.
		 */
		endpoint cssId String
		
		/**
		 * Auth Group property of the UI element.
		 */
		endpoint authorizationGroup String
		
		/**
		 * Auth Id property of the UI element.
		 */
		endpoint authorizationId String
	}
}

element Layout {
	uri view:UiLayout
	  
	bindings {
		
		// extends all bindings from Component
		extends Embeddable
		
		/**
		 * Editable property of the UI element.
		 */
		endpoint editable Boolean
		
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
		
		/**
		 * Attached component. 
		 */
		endpoint observeComponentAttach org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastComponentAttach
		
		/**
		 * Detached component.
		 */
		endpoint observeComponentDettach org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastComponentAttach
	}
}

element Field {
	uri view:UiField
	  
	bindings {
		
		// extends all bindings from Component
		extends Embeddable
		
		/**
		 * Editable property of the UI element.
		 */
		endpoint editable Boolean
		
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
		
		/**
		 * Readonly property of the element
		 */
		endpoint readonly Boolean
		
	}
}


element Browser {
	uri view:UiBrowser

	bindings {
		
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value Object
	}
}

element TextField {
	uri view:UiTextField
	
	bindings {
		// extends all bindings from Component
		extends Embeddable
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
		
		/**
		 * The textChange property. Read only.
		 */
		endpoint observeTextChange String target lastTextChange
	}
	
	validator {
		property validators
	} 
}

element UiMaskedTextField {
	uri view:UiMaskedTextField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * The mask that should be used for this UI element.
		 */
		endpoint mask String
	}
	
	validator {
		property validators
	} 
}

element UiMaskedNumericField {
	uri view:UiMaskedNumericField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * The mask that should be used for this UI element.
		 */
		endpoint mask String
	}
	
	validator {
		property validators
	} 
}

element UiMaskedDecimalField {
	uri view:UiMaskedDecimalField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * The mask that should be used for this UI element.
		 */
		endpoint mask String
	}
	
	validator {
		property validators
	} 
}

element UiPrefixedMaskedTextField {
	uri view:UiPrefixedMaskedTextField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * The mask that should be used for this UI element.
		 */
		endpoint mask String
	}
	
	validator {
		property validators
	} 
}

element PasswordField {
	uri view:UiPasswordField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
		
		/**
		 * The textChange property. Read only.
		 */
		endpoint observeTextChange String target lastTextChange
	}
	
	validator {
		property validators
	} 
}

element RichTextArea {
	uri view:UiRichTextArea
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Value property of the UI element.
		 */
		endpoint blobValue byte[]
		
	}
	
	validator {
		property validators
	} 
}

element SuggestTextField {
	uri view:UiSuggestTextField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Keys property of the UI element.
		 */
		endpoint keys String
		
		/**
		 * Returns the selected entry.
		 */
		final endpoint suggestion Object target lastSuggestion
		
		/**
		 * Events to open, close, navigate up and down and select.
		 */
		final endpoint event Object target event
		
		/**
		 * True if suggestions should be enabled. False otherwise.
		 */
		endpoint suggestionsEnabled Boolean target useSuggestions
	}
	
	validator {
		property validators
	} 
}  

element TextArea {  
	uri view:UiTextArea
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
		
		/**
		 * The textChange property. Read only.
		 */
		endpoint observeTextChange String target lastTextChange
	}
	
	validator {
		property validators
	} 
}  

element DateField {  
	uri view:UiDateField
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
	}
	
	validator {
		property validators
	} 
}  



element Label {
	uri view:UiLabel
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
	}
	 
	validator {
		property validators
	} 
} 

element Image {
	uri view:UiImage
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
		
		/**
		 * Resource property to bind resources.
		 */
		endpoint resource Object
	}

}  
    
element CheckBox {
	uri view:UiCheckBox
	
	bindings {
		// extends all bindings from Component
		extends Field
		  
		/**
		 * Value property of the UI element.
		 */
		endpoint value Boolean
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
		
	}
	
	validator {
		property validators
	}
}

element Button {
	uri view:UiButton
	  
	bindings {
		// extends all bindings from Component
		extends Embeddable
		  
		/**
		 * If the ui element is clicked, it will return
		 * the clicktime in milliseconds.
		 */
		endpoint onClick Long target lastClickTime
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
		/**
		 * Image resource property of the UI element.
		 */
		endpoint buttonImage Object target image
    
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
	}
}

element MobileNavigationButton {
	uri view:UiMobileNavigationButton
	 
	bindings {
		// extends all bindings from Component
		extends Embeddable
		
		/**
		 * If the ui element is clicked, it will return
		 * the clicktime in milliseconds.
		 */
		endpoint onClick Long target lastClickTime
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
	}
}

element ExposedAction {
	uri view:UiExposedAction
	 
	bindings {
		
		/**
		 * This method simulates and internal click that is
		 * forwarded to the "external" handler. To ensure 
		 * proper handling the "external" framework will call
		 * "onExecuted" or "onCanceled".
		 */
		endpoint click Long target internalClickTime
		
		/**
		 * Exposed actions are visualized outside the ECView core. 
		 * If these "external" actions are fired, then the click is
		 * forwarded to this method.
		 */
		endpoint onExternalClick Long target externalClickTime
		
		/**
		 * Becomes invoked if the action was executed properly.
		 */
		endpoint onExecuted Long target executedNotificationTime
		
		/**
		 * Becomes invoked if the action was canceled. For instance by a dialog.
		 */
		endpoint onCanceled Long target canceledNotificationTime
		
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
	}
}

element MobileNavigationBarAction {
	uri view:UiMobileNavBarAction
	 
	bindings {
		
		// extends all bindings from Component
		extends Embeddable
		
		/**
		 * If the ui element is clicked, it will return
		 * the clicktime in milliseconds.
		 */
		endpoint onClick Long target lastClickTime
		/**
		 * Enabled property of the UI element.
		 */
		endpoint enabled Boolean
	}
}

element NumericField {
	uri view:UiNumericField
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Value property of the UI element.
		 */
		endpoint value Integer
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
		
	}
	
	validator {
		property validators
	}
} 

element DecimalField {
	uri view:UiDecimalField
	
	bindings {
		
		// extends all bindings from Component
		extends Field
		/**
		 * Value property of the UI element.
		 */
		endpoint value Double
		/**
		 * Locale property of the UI element.
		 */
		endpoint locale Locale
		
		/**
		 * Focus property of the UI element. 
		 */
		endpoint observeFocus org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent  target lastFocusEvent
		
		/**
		 * The blur property. Read only.
		 */
		endpoint observeBlur org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableEvent target lastBlurEvent
	}
	
	validator {
		property validators
	}
} 

element List {  
	uri view:UiList
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Returns the selected entry.
		 * Only available in singleselection mode.
		 */
		final endpoint selection Object
		/**
		 * Returns the collection of list entries.
		 */
		list endpoint collection List<?>
		/**
		 * Returns the collection of multi selections.
		 * Only available in multiselection mode.
		 */
		endpoint multiSelection List<?>
	}

	validator {
		property validators
	}
}

element Table {
	uri view:UiTable
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Returns the selected entry.
		 * Only available in singleselection mode.
		 */
		final endpoint selection Object
		
		/**
		 * If any value is sent to this property, the table will become refreshed.
		 */
		endpoint refresh void
		
		/**
		 * Returns the collection of list entries.
		 */
		list endpoint collection List<?>
		/**
		 * Returns the collection of multi selections.
		 * Only available in multiselection mode.
		 */
		endpoint multiSelection List<?>
		/**
		 * The filter property for the table. 
		 * Filters can be applied to tables. As an input you may use a 
		 * binding to FilterPanel#filter 
		 */
		endpoint filter Object
		
		/**
		 * If any object is applied to this endpoint, the table triggers sorting
		 */
		endpoint doSort Object
	}

	validator {
		property validators
	}
}

element OptionsGroup {  
	uri view:UiOptionsGroup
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Returns the selected entry.
		 * Only available in singleselection mode.
		 */
		final endpoint selection Object
		/**
		 * Returns the collection of list entries.
		 */
		list endpoint collection List<?>
		/**
		 * Returns the collection of multi selections.
		 * Only available in multiselection mode.
		 */
		endpoint multiSelection List<?>
	}

	validator {
		property validators
	}
}

 
element ComboBox {  
	uri view:UiComboBox
	 
	bindings {
		// extends all bindings from Component
		extends Field
		/**
		 * Returns the selected entry.
		 */
		final endpoint selection Object
		/**
		 * Returns the collection of list entries.
		 */
		list endpoint collection List<?>
	}

	validator {
		property validators
	}
}

/**
 * A mobile navigation page.
 */
element MobileNavigationPage {   
	uri view:UiMobileNavigationPage

	bindings {
		 /**
		 * Value property of the UI element.
		 */
		final endpoint value Object
		
		/**
		 * If any object is set to this property, the navigation page
		 * will navigate back.
		 */
		final endpoint navigateBack void
		
		/**
		 * If the navigation page is closed, it will return
		 * the clicktime in milliseconds.
		 */
		endpoint onNavigateBack Long
	}

	validator {
		property validators
	}
}

element GridLayout {
	uri view:UiGridLayout
	
	bindings {
		// extends all bindings from Component
		extends Layout
		
		/**
		 * The number of columns in the GridLayout.
		 */
		endpoint columns Integer
	}
	
}

element Dialog {
	uri view:UiDialog
	
	bindings {
		/**
		 * Editable property of the UI element.
		 */
		endpoint editable Boolean
		/**
		 * Visible property of the UI element.
		 */
		endpoint visible Boolean
		/**
		 * Input value property of the UI element.
		 * Every dialog needs to become passed an input value.
		 */
		endpoint value Object
	}
	
}

element VerticalLayout {
	uri view:UiVerticalLayout
	
	bindings {
		// extends all bindings from Component
		extends Layout
		
	}
	
}

element VerticalGroup {
	uri view:UiVerticalComponentGroup
	
	bindings {
		// extends all bindings from Component
		extends Layout
		
	}
	
}

element SearchField {
	uri view:UiSearchField
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Value property of the UI element.
		 */
		endpoint value String
	}
	
}

element Form {
	uri view:UiFormLayout
	
	bindings {
		
		// extends all bindings from Component
		extends Layout
		
	}
	
}

element VerticalGroup {
	uri view:UiVerticalComponentGroup
	
	bindings {
		// extends all bindings from Component
		extends Layout
		
	}
	
}

element SplitPanel {
	uri view:UiSplitPanel
	
	bindings {
		// extends all bindings from Component
		extends Layout
		
		/**
		 * The split position of the panel
		 */
		endpoint splitPosition Integer
		
		/**
		 * Wether vertical or horizontal
		 */
		endpoint vertical Boolean				
	}
	
}

element Switch {
	uri view:UiSwitch
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Value property of the UI element.
		 */
		endpoint value Boolean
	}
	
}

element ProgressBar {  
	uri view:UiProgressBar
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Value property of the UI element.
		 */
		endpoint value Float
	}
}

/**
 * Search panel is a layout where SearchFields can be put in. A search panel
 * needs to be <code>typed</code>. So you have to specify a <code>JvmType</code>
 * for its <code>type-property</code>. The type property is the <code>java class</code>
 * you want to query for. For instance JPA, JDBC,... 
 */
element SearchPanel {
	uri view:UiSearchPanel

	bindings {
		// extends all bindings from Component
		extends Layout
		
		/*
		 * If <code>any kind of value</code> is passed to this property, the 
		 * search panel will collect the filter from it's search fields
		 * and puts the properly prepared filter to it's filter property.<br>
		 * To get an instance of the filter, just bind the <code>#filter</code> 
		 * property of this panel to any search target.<br>
		 * The type of returned filter depends on the used UI-Kit.
		 */  
		endpoint applyFilter Object
		
		/**
		 * This property contains a properly prepared filter. The search panel
		 * will assemble a filter based on the contained search fields. <br>
		 * Assembling filter is triggered by the <code>#applyFilter</code>
		 * property.
		 * <br>
		 * The type of returned filter depends on the used UI-Kit.
		 */
		endpoint filter Object
	}
}

/**
 * Search panel is a layout where SearchFields can be put in. A search panel
 * needs to be <code>typed</code>. So you have to specify a <code>JvmType</code>
 * for its <code>type-property</code>. The type property is the <code>java class</code>
 * you want to query for. For instance JPA, JDBC,... 
 */
element MobileSearchPanel {
	uri view:UiMobileSearchPanel

	bindings {
		// extends all bindings from Component
		extends Layout
		
		/*
		 * If <code>any kind of value</code> is passed to this property, the 
		 * search panel will collect the filter from it's search fields
		 * and puts the properly prepared filter to it's filter property.<br>
		 * To get an instance of the filter, just bind the <code>#filter</code> 
		 * property of this panel to any search target.<br>
		 * The type of returned filter depends on the used UI-Kit.
		 */  
		endpoint applyFilter Object
		
		/**
		 * This property contains a properly prepared filter. The search panel
		 * will assemble a filter based on the contained search fields. <br>
		 * Assembling filter is triggered by the <code>#applyFilter</code>
		 * property.
		 * <br>
		 * The type of returned filter depends on the used UI-Kit.
		 */
		endpoint filter Object
	}
}
 
element BeanReferenceField {  
	uri view:UiBeanReferenceField
	
	bindings {
		// extends all bindings from Component
		extends Field
		
		/**
		 * Value property of the UI element.
		 */
		endpoint value Object
	}
}