OracleJavaScript API Reference for Oracle ADF Faces

 

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.js.component.rich.input
Class AdfRichInputColor

org.ecmascript.object.Object
   |
   +--org.apache.myjs.trinidad.component.AdfUIValue
         |
         +--org.apache.myjs.trinidad.component.AdfUIEditableValue
               |
               +--org.apache.myjs.trinidad.component.AdfUISelectInput
                     |
                     +--oracle.adf.view.js.component.rich.input.AdfRichInputColor

public class AdfRichInputColor
extends AdfUISelectInput
Renders an input field for colors. The field can be tied to a ChooseColor element for easy color picking.

When chooseId attribute is set, the field is tied to a chooseColor with the specified Id, and in that case values of attribute colorData, customColorData, defaultColor and width are ignored.

When chooseId attribute is not set, the field has its own popup chooseColor, and attribute colorData, customColorData, defaultColor and width are used to specifiy properties of the popup chooseColor.

Action event and Return event are not fired in rich client. They are only fired in PDA.

Note: The value attribute should be a java.awt.Color object.



Field Summary


Fields inherited from org.ecmascript.object.Object

constructor, prototype


Constructor Summary

public
AdfRichInputColor()
Renders an input field for colors.


Method Summary

public String
getAccessKey()
Get function for attribute for 'accessKey'.
public Boolean
getAutoSubmit()
Get function for attribute for 'autoSubmit'.
public Boolean
getChanged()
Get function for attribute for 'changed'.
public String
getChangedDesc()
Get function for attribute for 'changedDesc'.
protected Object
GetChanges()
Override to encode custom data array.
public String
getChooseId()
Get function for attribute for 'chooseId'.
public Array
getColorData()
Get function for attribute for 'colorData'.
public Number
getColumns()
Get function for attribute for 'columns'.
public Boolean
getCompact()
Get function for attribute for 'compact'.
public String
getContentStyle()
Get function for attribute for 'contentStyle'.
protected Object
GetConvertedValue(Object submittedValue)
Override to handle blank value
public Array
getCustomColorData()
Get function for attribute for 'customColorData'.
public Boolean
getCustomVisible()
Get function for attribute for 'customVisible'.
public Object
getDefaultColor()
Get function for attribute for 'defaultColor'.
public Boolean
getDefaultVisible()
Get function for attribute for 'defaultVisible'.
public Boolean
getDisabled()
Get function for attribute for 'disabled'.
public String
getHelpTopicId()
Get function for attribute for 'helpTopicId'.
public String
getInlineStyle()
Get function for attribute for 'inlineStyle'.
public String
getLabel()
Get function for attribute for 'label'.
public Boolean
getLastUsedVisible()
Get function for attribute for 'lastUsedVisible'.
public Boolean
getReadOnly()
Get function for attribute for 'readOnly'.
public String
getShortDesc()
Get function for attribute for 'shortDesc'.
public Boolean
getShowRequired()
Get function for attribute for 'showRequired'.
public Boolean
getSimple()
Get function for attribute for 'simple'.
public String
getStyleClass()
Get function for attribute for 'styleClass'.
public Boolean
getVisible()
Get function for attribute for 'visible'.
public Number
getWidth()
Get function for attribute for 'width'.
public void
setAccessKey(String newAccessKey)
Set function for attribute 'AccessKey'.
public void
setAutoSubmit(Boolean newAutoSubmit)
Set function for attribute 'AutoSubmit'.
public void
setChanged(Boolean newChanged)
Set function for attribute 'Changed'.
public void
setChangedDesc(String newChangedDesc)
Set function for attribute 'ChangedDesc'.
public void
setColorData(Array newColorData)
Set function for attribute 'ColorData'.
public void
setColumns(Number newColumns)
Set function for attribute 'Columns'.
public void
setCompact(Boolean newCompact)
Set function for attribute 'Compact'.
public void
setContentStyle(String newContentStyle)
Set function for attribute 'ContentStyle'.
public void
setCustomColorData(Array newCustomColorData)
Set function for attribute 'CustomColorData'.
public void
setCustomVisible(Boolean newCustomVisible)
Set function for attribute 'CustomVisible'.
public void
setDefaultColor(Object newDefaultColor)
Set function for attribute 'DefaultColor'.
public void
setDefaultVisible(Boolean newDefaultVisible)
Set function for attribute 'DefaultVisible'.
public void
setHelpTopicId(String newHelpTopicId)
Set function for attribute 'HelpTopicId'.
public void
setInlineStyle(String newInlineStyle)
Set function for attribute 'InlineStyle'.
public void
setLabel(String newLabel)
Set function for attribute 'Label'.
public void
setLastUsedVisible(Boolean newLastUsedVisible)
Set function for attribute 'LastUsedVisible'.
public void
setShortDesc(String newShortDesc)
Set function for attribute 'ShortDesc'.
public void
setShowRequired(Boolean newShowRequired)
Set function for attribute 'ShowRequired'.
public void
setSimple(Boolean newSimple)
Set function for attribute 'Simple'.
public void
setStyleClass(String newStyleClass)
Set function for attribute 'StyleClass'.
public void
setVisible(Boolean newVisible)
Set function for attribute 'Visible'.
public void
setWidth(Number newWidth)
Set function for attribute 'Width'.


Methods inherited from org.apache.myjs.trinidad.component.AdfUISelectInput

getActionExpression, getReturnListener


Methods inherited from org.apache.myjs.trinidad.component.AdfUIEditableValue

addValidator, DeliverDerivedPropertyEvents, getImmediate, getLocalValueSet, getRequired, GetRequiredKey, getRequiredMessageDetail, getSubmittedValue, getValid, getValidators, getValue, InitSubclass, IsEmpty, isEventRoot, resetValue, SetPropertyImpl, setValue, validate, ValidateValue


Methods inherited from org.apache.myjs.trinidad.component.AdfUIValue

getConverter, isConvertible


Field Detail


Constructor Detail


AdfRichInputColor

public AdfRichInputColor()

Renders an input field for colors. The field can be tied to a ChooseColor element for easy color picking.

When chooseId attribute is set, the field is tied to a chooseColor with the specified Id, and in that case values of attribute colorData, customColorData, defaultColor and width are ignored.

When chooseId attribute is not set, the field has its own popup chooseColor, and attribute colorData, customColorData, defaultColor and width are used to specifiy properties of the popup chooseColor.

Action event and Return event are not fired in rich client. They are only fired in PDA.

Note: The value attribute should be a java.awt.Color object.


Method Detail


getAccessKey

public String getAccessKey()

Get function for attribute for 'accessKey'.

Return:
String - AccessKey

getAutoSubmit

public Boolean getAutoSubmit()

Get function for attribute for 'autoSubmit'.

Return:
Boolean - AutoSubmit

getChanged

public Boolean getChanged()

Get function for attribute for 'changed'.

Return:
Boolean - Changed

getChangedDesc

public String getChangedDesc()

Get function for attribute for 'changedDesc'.

Return:
String - ChangedDesc

GetChanges

protected Object GetChanges()

Override to encode custom data array.

Return:
Object
Overrides:
AdfUIValue.GetChanges()

getChooseId

public String getChooseId()

Get function for attribute for 'chooseId'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:
String - ChooseId

getColorData

public Array getColorData()

Get function for attribute for 'colorData'.

Return:
Array - ColorData

getColumns

public Number getColumns()

Get function for attribute for 'columns'.

Return:
Number - Columns

getCompact

public Boolean getCompact()

Get function for attribute for 'compact'.

Return:
Boolean - Compact

getContentStyle

public String getContentStyle()

Get function for attribute for 'contentStyle'.

Return:
String - ContentStyle

GetConvertedValue

protected Object GetConvertedValue(Object submittedValue)

Override to handle blank value

Parameters:
submittedValue    
Return:
Object
Overrides:
AdfUIValue.GetConvertedValue(Object)

getCustomColorData

public Array getCustomColorData()

Get function for attribute for 'customColorData'.

Return:
Array - CustomColorData

getCustomVisible

public Boolean getCustomVisible()

Get function for attribute for 'customVisible'.

Return:
Boolean - CustomVisible

getDefaultColor

public Object getDefaultColor()

Get function for attribute for 'defaultColor'.

Return:
Object - DefaultColor

getDefaultVisible

public Boolean getDefaultVisible()

Get function for attribute for 'defaultVisible'.

Return:
Boolean - DefaultVisible

getDisabled

public Boolean getDisabled()

Get function for attribute for 'disabled'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:
Boolean - Disabled

getHelpTopicId

public String getHelpTopicId()

Get function for attribute for 'helpTopicId'.

Return:
String - HelpTopicId

getInlineStyle

public String getInlineStyle()

Get function for attribute for 'inlineStyle'.

Return:
String - InlineStyle

getLabel

public String getLabel()

Get function for attribute for 'label'.

Return:
String - Label

getLastUsedVisible

public Boolean getLastUsedVisible()

Get function for attribute for 'lastUsedVisible'.

Return:
Boolean - LastUsedVisible

getReadOnly

public Boolean getReadOnly()

Get function for attribute for 'readOnly'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:
Boolean - ReadOnly

getShortDesc

public String getShortDesc()

Get function for attribute for 'shortDesc'.

Return:
String - ShortDesc

getShowRequired

public Boolean getShowRequired()

Get function for attribute for 'showRequired'.

Return:
Boolean - ShowRequired

getSimple

public Boolean getSimple()

Get function for attribute for 'simple'.

Return:
Boolean - Simple

getStyleClass

public String getStyleClass()

Get function for attribute for 'styleClass'.

Return:
String - StyleClass

getVisible

public Boolean getVisible()

Get function for attribute for 'visible'.

Return:
Boolean - Visible

getWidth

public Number getWidth()

Get function for attribute for 'width'.

Return:
Number - Width

setAccessKey

public void setAccessKey(String newAccessKey)

Set function for attribute 'AccessKey'.

Parameters:
newAccessKey    
Return:
void - No Value returned

setAutoSubmit

public void setAutoSubmit(Boolean newAutoSubmit)

Set function for attribute 'AutoSubmit'.

Parameters:
newAutoSubmit    
Return:
void - No Value returned

setChanged

public void setChanged(Boolean newChanged)

Set function for attribute 'Changed'.

Parameters:
newChanged    
Return:
void - No Value returned

setChangedDesc

public void setChangedDesc(String newChangedDesc)

Set function for attribute 'ChangedDesc'.

Parameters:
newChangedDesc    
Return:
void - No Value returned

setColorData

public void setColorData(Array newColorData)

Set function for attribute 'ColorData'.

Parameters:
newColorData    
Return:
void - No Value returned

setColumns

public void setColumns(Number newColumns)

Set function for attribute 'Columns'.

Parameters:
newColumns    
Return:
void - No Value returned

setCompact

public void setCompact(Boolean newCompact)

Set function for attribute 'Compact'.

Parameters:
newCompact    
Return:
void - No Value returned

setContentStyle

public void setContentStyle(String newContentStyle)

Set function for attribute 'ContentStyle'.

Parameters:
newContentStyle    
Return:
void - No Value returned

setCustomColorData

public void setCustomColorData(Array newCustomColorData)

Set function for attribute 'CustomColorData'.

Parameters:
newCustomColorData    
Return:
void - No Value returned

setCustomVisible

public void setCustomVisible(Boolean newCustomVisible)

Set function for attribute 'CustomVisible'.

Parameters:
newCustomVisible    
Return:
void - No Value returned

setDefaultColor

public void setDefaultColor(Object newDefaultColor)

Set function for attribute 'DefaultColor'.

Parameters:
newDefaultColor    
Return:
void - No Value returned

setDefaultVisible

public void setDefaultVisible(Boolean newDefaultVisible)

Set function for attribute 'DefaultVisible'.

Parameters:
newDefaultVisible    
Return:
void - No Value returned

setHelpTopicId

public void setHelpTopicId(String newHelpTopicId)

Set function for attribute 'HelpTopicId'.

Parameters:
newHelpTopicId    
Return:
void - No Value returned

setInlineStyle

public void setInlineStyle(String newInlineStyle)

Set function for attribute 'InlineStyle'.

Parameters:
newInlineStyle    
Return:
void - No Value returned

setLabel

public void setLabel(String newLabel)

Set function for attribute 'Label'.

Parameters:
newLabel    
Return:
void - No Value returned

setLastUsedVisible

public void setLastUsedVisible(Boolean newLastUsedVisible)

Set function for attribute 'LastUsedVisible'.

Parameters:
newLastUsedVisible    
Return:
void - No Value returned

setShortDesc

public void setShortDesc(String newShortDesc)

Set function for attribute 'ShortDesc'.

Parameters:
newShortDesc    
Return:
void - No Value returned

setShowRequired

public void setShowRequired(Boolean newShowRequired)

Set function for attribute 'ShowRequired'.

Parameters:
newShowRequired    
Return:
void - No Value returned

setSimple

public void setSimple(Boolean newSimple)

Set function for attribute 'Simple'.

Parameters:
newSimple    
Return:
void - No Value returned

setStyleClass

public void setStyleClass(String newStyleClass)

Set function for attribute 'StyleClass'.

Parameters:
newStyleClass    
Return:
void - No Value returned

setVisible

public void setVisible(Boolean newVisible)

Set function for attribute 'Visible'.

Parameters:
newVisible    
Return:
void - No Value returned

setWidth

public void setWidth(Number newWidth)

Set function for attribute 'Width'.

Parameters:
newWidth    
Return:
void - No Value returned

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

 

Generated on 2009.04.27 01:06 UTC
Copyright (c) 1998, 2008, Oracle and/or its affiliates. All rights reserved.