Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


oracle.adf.view.rich.util
Class CalendarActivityRamp

java.lang.Object
  extended by oracle.adf.view.rich.util.InstanceStyles
      extended by oracle.adf.view.rich.util.CalendarActivityRamp

All Implemented Interfaces:
java.io.Serializable

public final class CalendarActivityRamp
extends InstanceStyles
implements java.io.Serializable

CalendarActivityRamp is a subclass of InstanceStyles Class that takes a color ramp and returns the appropriate styles for the calendar skinning keys passed in.

In many calendars each provider uses different colors, for example owner calendar activities are blue, holiday calendar activities are red, and boss calendar activities are green. However a 'blue' calendar doesn't use a single shade of blue, instead it uses a blue color ramp, some areas are medium, light, or dark blue. A calendarActivityRamp provides styles for a ramp.

CalendarActivityRamp can be used with the activityStyles attribute on the calendar component.

Author:
The Oracle ADF Faces Team
See Also:
Serialized Form

Nested Class Summary
static class CalendarActivityRamp.RampKey
           

 

Constructor Summary
CalendarActivityRamp(java.awt.Color veryDarkColor, java.awt.Color darkColor, java.awt.Color mediumColor)
           

 

Method Summary
static CalendarActivityRamp getActivityRamp(CalendarActivityRamp.RampKey key)
          Return a CalendarActivityRamp object based on a key name.
static CalendarActivityRamp getActivityRamp(java.awt.Color representativeColor)
          Return a CalendarActivityRamp object based on the representative color.
 java.lang.String getInlineStyle(java.lang.String skinningKey)
           
static java.util.List<java.awt.Color> getRampColorKeys()
          Each time this method is called the internal list is cloned, so cache the return value if possible
 java.awt.Color getRepresentativeColor()
          this color represents the ramp as a whole and could be used to show in a provider 'legend' area or passed to an inputColor

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

CalendarActivityRamp

public CalendarActivityRamp(java.awt.Color veryDarkColor,
                            java.awt.Color darkColor,
                            java.awt.Color mediumColor)
Parameters:
veryDarkColor - - very dark color in ramp
darkColor - - dark color in ramp
mediumColor - - medium color in ramp

Method Detail

getRampColorKeys

public static java.util.List<java.awt.Color> getRampColorKeys()
Each time this method is called the internal list is cloned, so cache the return value if possible
Returns:
The list of legal keys that can be passed to getActivityRamp(Color representativeColor)

getActivityRamp

public static CalendarActivityRamp getActivityRamp(CalendarActivityRamp.RampKey key)
Return a CalendarActivityRamp object based on a key name. The CalendarActivityRamp can be used in conjunction with the activityStyles attribute on the calendar. The supported keys are enumerated in the RampKey object.
Parameters:
key - the key to use to find a CalendarActivityRamp object
Returns:
a calendarActivityRamp object, which can be used in conjunction with the activityStyles attribute on the calendar.

getActivityRamp

public static CalendarActivityRamp getActivityRamp(java.awt.Color representativeColor)
Return a CalendarActivityRamp object based on the representative color. The CalendarActivityRamp can be used in conjunction with the activityStyles attribute on the calendar. The supported keys are available from getRampColorKeys()
Parameters:
representativeColor - the key to use to find a CalendarActivityRamp object
Returns:
a calendarActivityRamp object, which can be used in conjunction with the activityStyles attribute on the calendar.

getInlineStyle

public java.lang.String getInlineStyle(java.lang.String skinningKey)
Specified by:
getInlineStyle in class InstanceStyles
Parameters:
skinningKey - publicly documented skinning key, for example "af|inputText"
Returns:
inline style string, for example "background-color:red"

getRepresentativeColor

public java.awt.Color getRepresentativeColor()
this color represents the ramp as a whole and could be used to show in a provider 'legend' area or passed to an inputColor

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.